From 80b80cef93d9dff6acc4bc8e3a522c55fcdc3fca Mon Sep 17 00:00:00 2001 From: Pekka Riikonen Date: Tue, 6 May 2014 20:15:50 +0200 Subject: [PATCH] updates. --- docs/client/ChangeLog | 407 +++ docs/client/ReleaseNotes | 1 + docs/server/ChangeLog | 213 ++ docs/silcd.conf.5 | 584 ++++ docs/silcd.pub | 14 + docs/silcnet_silcd.conf | 14 + docs/toolkit/ChangeLog | 356 +++ docs/toolkit/manual/arch.gif | Bin 0 -> 119513 bytes docs/toolkit/manual/box.gif | Bin 0 -> 59 bytes docs/toolkit/manual/box2.gif | Bin 0 -> 60 bytes docs/toolkit/manual/building.html | 415 +++ docs/toolkit/manual/command_reply_args.html | 615 ++++ docs/toolkit/manual/dot.gif | Bin 0 -> 71 bytes docs/toolkit/manual/index.html | 164 + docs/toolkit/manual/index.tmpl | 98 + docs/toolkit/manual/index_pic.gif | Bin 0 -> 60 bytes docs/toolkit/manual/intro_reference.html | 323 ++ docs/toolkit/manual/notifyargs.html | 477 +++ docs/toolkit/manual/platforms.html | 273 ++ docs/toolkit/manual/porting.html | 872 ++++++ docs/toolkit/manual/programming_conv.html | 402 +++ ...il-silc_change_private_key_passphrase.html | 235 ++ .../silcapputil-silc_channel_name_check.html | 257 ++ .../silcapputil-silc_channel_name_verify.html | 242 ++ .../silcapputil-silc_client_chmode.html | 231 ++ .../silcapputil-silc_client_chumode.html | 230 ++ .../silcapputil-silc_client_chumode_char.html | 230 ++ .../silcapputil-silc_create_key_pair.html | 264 ++ .../silcapputil-silc_get_command_name.html | 230 ++ .../silcapputil-silc_get_mode_list.html | 235 ++ .../silcapputil-silc_get_packet_name.html | 230 ++ .../silcapputil-silc_get_status_message.html | 230 ++ .../manual/silcapputil-silc_id_render.html | 230 ++ .../silcapputil-silc_identifier_check.html | 261 ++ .../silcapputil-silc_identifier_verify.html | 246 ++ .../silcapputil-silc_load_key_pair.html | 239 ++ ...silcapputil-silc_parse_version_string.html | 235 ++ .../silcapputil-silc_show_public_key.html | 231 ++ ...silcapputil-silc_show_public_key_file.html | 232 ++ .../silcapputil-silc_version_to_num.html | 230 ++ docs/toolkit/manual/silcapputil.html | 238 ++ docs/toolkit/manual/silcapputil.xref | 26 + docs/toolkit/manual/silcaputillib.html | 218 ++ .../silcargument-SilcArgumentDecodeType.html | 236 ++ .../silcargument-SilcArgumentDecodedList.html | 229 ++ .../silcargument-SilcArgumentPayload.html | 230 ++ ...ilcargument-silc_argument_get_arg_num.html | 227 ++ ...lcargument-silc_argument_get_arg_type.html | 233 ++ ...ilcargument-silc_argument_get_decoded.html | 255 ++ ...cargument-silc_argument_get_first_arg.html | 231 ++ ...lcargument-silc_argument_get_next_arg.html | 231 ++ .../silcargument-silc_argument_list_free.html | 228 ++ ...silcargument-silc_argument_list_parse.html | 231 ++ ...ment-silc_argument_list_parse_decoded.html | 234 ++ ...argument-silc_argument_payload_encode.html | 234 ++ ...ment-silc_argument_payload_encode_one.html | 233 ++ ...-silc_argument_payload_encode_payload.html | 229 ++ ...lcargument-silc_argument_payload_free.html | 227 ++ ...cargument-silc_argument_payload_parse.html | 235 ++ docs/toolkit/manual/silcargument.html | 229 ++ docs/toolkit/manual/silcargument.xref | 23 + .../manual/silcasn1-SILC_ASN1_ANY.html | 278 ++ .../silcasn1-SILC_ASN1_ANY_PRIMITIVE.html | 284 ++ .../manual/silcasn1-SILC_ASN1_BIT_STRING.html | 261 ++ .../manual/silcasn1-SILC_ASN1_BMP_STRING.html | 267 ++ .../manual/silcasn1-SILC_ASN1_BOOLEAN.html | 259 ++ .../manual/silcasn1-SILC_ASN1_CHOICE.html | 266 ++ .../manual/silcasn1-SILC_ASN1_END.html | 254 ++ .../manual/silcasn1-SILC_ASN1_ENUM.html | 259 ++ .../silcasn1-SILC_ASN1_GENERAL_STRING.html | 267 ++ .../manual/silcasn1-SILC_ASN1_GEN_TIME.html | 259 ++ .../manual/silcasn1-SILC_ASN1_IA5_STRING.html | 267 ++ .../manual/silcasn1-SILC_ASN1_INT.html | 259 ++ .../manual/silcasn1-SILC_ASN1_NULL.html | 258 ++ .../silcasn1-SILC_ASN1_NUMERIC_STRING.html | 267 ++ .../silcasn1-SILC_ASN1_OCTET_STRING.html | 260 ++ .../manual/silcasn1-SILC_ASN1_OID.html | 259 ++ .../manual/silcasn1-SILC_ASN1_OPTS.html | 272 ++ .../silcasn1-SILC_ASN1_PRINTABLE_STRING.html | 267 ++ .../manual/silcasn1-SILC_ASN1_SEQUENCE.html | 269 ++ .../silcasn1-SILC_ASN1_SEQUENCE_OF.html | 275 ++ .../manual/silcasn1-SILC_ASN1_SET.html | 268 ++ .../manual/silcasn1-SILC_ASN1_SET_OF.html | 272 ++ .../manual/silcasn1-SILC_ASN1_SHORT_INT.html | 259 ++ .../silcasn1-SILC_ASN1_TELETEX_STRING.html | 267 ++ .../silcasn1-SILC_ASN1_UNIVERSAL_STRING.html | 267 ++ ...ilcasn1-SILC_ASN1_UNRESTRICTED_STRING.html | 267 ++ .../manual/silcasn1-SILC_ASN1_UTC_TIME.html | 259 ++ .../silcasn1-SILC_ASN1_UTF8_STRING.html | 267 ++ .../silcasn1-SILC_ASN1_VISIBLE_STRING.html | 267 ++ docs/toolkit/manual/silcasn1-SilcAsn1.html | 254 ++ .../manual/silcasn1-SilcAsn1Options.html | 305 ++ .../manual/silcasn1-SilcAsn1Struct.html | 253 ++ docs/toolkit/manual/silcasn1-SilcAsn1Tag.html | 285 ++ .../manual/silcasn1-silc_asn1_alloc.html | 262 ++ .../manual/silcasn1-silc_asn1_decode.html | 296 ++ .../manual/silcasn1-silc_asn1_encode.html | 292 ++ .../manual/silcasn1-silc_asn1_free.html | 252 ++ .../manual/silcasn1-silc_asn1_init.html | 260 ++ .../manual/silcasn1-silc_asn1_uninit.html | 251 ++ docs/toolkit/manual/silcasn1.html | 275 ++ docs/toolkit/manual/silcasn1.xref | 46 + docs/toolkit/manual/silcasn1_i.html | 203 ++ docs/toolkit/manual/silcasn1_i.xref | 6 + docs/toolkit/manual/silcasn1lib.html | 218 ++ .../manual/silcasync-SilcAsyncOperation.html | 227 ++ .../silcasync-SilcAsyncOperationAbort.html | 229 ++ .../silcasync-SilcAsyncOperationPause.html | 231 ++ .../silcasync-SilcAsyncOperationStruct.html | 226 ++ .../manual/silcasync-silc_async_abort.html | 232 ++ .../manual/silcasync-silc_async_alloc.html | 256 ++ .../manual/silcasync-silc_async_free.html | 228 ++ .../silcasync-silc_async_get_context.html | 223 ++ .../manual/silcasync-silc_async_halt.html | 228 ++ .../manual/silcasync-silc_async_init.html | 236 ++ .../manual/silcasync-silc_async_resume.html | 227 ++ docs/toolkit/manual/silcasync.html | 235 ++ docs/toolkit/manual/silcasync.xref | 18 + docs/toolkit/manual/silcasync_i.html | 203 ++ docs/toolkit/manual/silcasync_i.xref | 6 + .../manual/silcatomic-SilcAtomic16.html | 265 ++ .../manual/silcatomic-SilcAtomic32.html | 265 ++ .../manual/silcatomic-SilcAtomic8.html | 265 ++ .../manual/silcatomic-SilcAtomicPointer.html | 265 ++ .../silcatomic-silc_atomic_add_int16.html | 249 ++ .../silcatomic-silc_atomic_add_int32.html | 249 ++ .../silcatomic-silc_atomic_add_int8.html | 249 ++ .../manual/silcatomic-silc_atomic_cas16.html | 252 ++ .../manual/silcatomic-silc_atomic_cas32.html | 252 ++ .../manual/silcatomic-silc_atomic_cas8.html | 252 ++ .../silcatomic-silc_atomic_cas_pointer.html | 252 ++ .../manual/silcatomic-silc_atomic_dec16.html | 248 ++ .../manual/silcatomic-silc_atomic_dec32.html | 248 ++ .../manual/silcatomic-silc_atomic_dec8.html | 248 ++ .../silcatomic-silc_atomic_get_int16.html | 248 ++ .../silcatomic-silc_atomic_get_int32.html | 248 ++ .../silcatomic-silc_atomic_get_int8.html | 248 ++ .../silcatomic-silc_atomic_get_pointer.html | 248 ++ .../manual/silcatomic-silc_atomic_inc16.html | 248 ++ .../manual/silcatomic-silc_atomic_inc32.html | 248 ++ .../manual/silcatomic-silc_atomic_inc8.html | 248 ++ .../manual/silcatomic-silc_atomic_init16.html | 250 ++ .../manual/silcatomic-silc_atomic_init32.html | 250 ++ .../manual/silcatomic-silc_atomic_init8.html | 250 ++ .../silcatomic-silc_atomic_init_pointer.html | 251 ++ .../silcatomic-silc_atomic_set_int16.html | 248 ++ .../silcatomic-silc_atomic_set_int32.html | 248 ++ .../silcatomic-silc_atomic_set_int8.html | 248 ++ .../silcatomic-silc_atomic_set_pointer.html | 248 ++ .../silcatomic-silc_atomic_sub_int16.html | 249 ++ .../silcatomic-silc_atomic_sub_int32.html | 249 ++ .../silcatomic-silc_atomic_sub_int8.html | 249 ++ .../silcatomic-silc_atomic_uninit16.html | 249 ++ .../silcatomic-silc_atomic_uninit32.html | 249 ++ .../silcatomic-silc_atomic_uninit8.html | 249 ++ ...silcatomic-silc_atomic_uninit_pointer.html | 249 ++ docs/toolkit/manual/silcatomic.html | 260 ++ docs/toolkit/manual/silcatomic.xref | 43 + .../manual/silcattrs-SilcAttribute.html | 262 ++ .../silcattrs-SilcAttributeContact.html | 247 ++ .../manual/silcattrs-SilcAttributeDevice.html | 242 ++ .../manual/silcattrs-SilcAttributeFlags.html | 242 ++ .../manual/silcattrs-SilcAttributeMood.html | 251 ++ .../silcattrs-SilcAttributeObjDevice.html | 244 ++ .../manual/silcattrs-SilcAttributeObjGeo.html | 243 ++ .../manual/silcattrs-SilcAttributeObjPN.html | 241 ++ .../manual/silcattrs-SilcAttributeObjPk.html | 255 ++ .../silcattrs-SilcAttributeObjService.html | 243 ++ .../silcattrs-SilcAttributePNFormat.html | 241 ++ .../silcattrs-SilcAttributePayload.html | 237 ++ ...ilcattrs-silc_attribute_get_attribute.html | 234 ++ .../silcattrs-silc_attribute_get_data.html | 237 ++ .../silcattrs-silc_attribute_get_flags.html | 235 ++ .../silcattrs-silc_attribute_get_object.html | 263 ++ ...cattrs-silc_attribute_get_verify_data.html | 243 ++ ...ilcattrs-silc_attribute_payload_alloc.html | 242 ++ ...lcattrs-silc_attribute_payload_encode.html | 247 ++ ...rs-silc_attribute_payload_encode_data.html | 244 ++ ...silcattrs-silc_attribute_payload_free.html | 234 ++ ...ttrs-silc_attribute_payload_list_free.html | 234 ++ ...ilcattrs-silc_attribute_payload_parse.html | 239 ++ docs/toolkit/manual/silcattrs.html | 237 ++ docs/toolkit/manual/silcattrs.xref | 30 + .../manual/silcauth-SilcAuthMethod.html | 242 ++ .../manual/silcauth-SilcAuthPayload.html | 236 ++ .../silcauth-SilcKeyAgreementPayload.html | 235 ++ .../manual/silcauth-silc_auth_get_data.html | 235 ++ .../manual/silcauth-silc_auth_get_method.html | 232 ++ .../silcauth-silc_auth_get_public_data.html | 234 ++ .../silcauth-silc_auth_payload_encode.html | 241 ++ .../silcauth-silc_auth_payload_free.html | 232 ++ .../silcauth-silc_auth_payload_parse.html | 234 ++ ...th-silc_auth_public_key_auth_generate.html | 246 ++ ...lc_auth_public_key_auth_generate_wpub.html | 242 ++ ...auth-silc_auth_public_key_auth_verify.html | 236 ++ ...silc_auth_public_key_auth_verify_data.html | 239 ++ .../manual/silcauth-silc_auth_verify.html | 240 ++ .../silcauth-silc_auth_verify_data.html | 243 ++ ...cauth-silc_key_agreement_get_hostname.html | 234 ++ .../silcauth-silc_key_agreement_get_port.html | 234 ++ ...cauth-silc_key_agreement_get_protocol.html | 234 ++ ...uth-silc_key_agreement_payload_encode.html | 235 ++ ...cauth-silc_key_agreement_payload_free.html | 232 ++ ...auth-silc_key_agreement_payload_parse.html | 234 ++ docs/toolkit/manual/silcauth.html | 242 ++ docs/toolkit/manual/silcauth.xref | 28 + docs/toolkit/manual/silcber-SilcBerClass.html | 216 ++ .../manual/silcber-SilcBerEncoding.html | 216 ++ .../manual/silcber-silc_ber_decode.html | 228 ++ .../manual/silcber-silc_ber_encode.html | 224 ++ .../manual/silcber-silc_ber_encoded_len.html | 219 ++ docs/toolkit/manual/silcber.html | 224 ++ docs/toolkit/manual/silcber.xref | 12 + .../toolkit/manual/silcbuffer-SilcBuffer.html | 323 ++ .../manual/silcbuffer-silc_buffer_alloc.html | 248 ++ .../silcbuffer-silc_buffer_alloc_size.html | 250 ++ .../manual/silcbuffer-silc_buffer_clear.html | 249 ++ .../manual/silcbuffer-silc_buffer_clone.html | 250 ++ .../manual/silcbuffer-silc_buffer_copy.html | 250 ++ .../manual/silcbuffer-silc_buffer_data.html | 250 ++ .../silcbuffer-silc_buffer_datalen.html | 261 ++ .../manual/silcbuffer-silc_buffer_end.html | 251 ++ .../silcbuffer-silc_buffer_enlarge.html | 254 ++ .../manual/silcbuffer-silc_buffer_free.html | 255 ++ .../silcbuffer-silc_buffer_headlen.html | 247 ++ .../manual/silcbuffer-silc_buffer_len.html | 247 ++ .../manual/silcbuffer-silc_buffer_pull.html | 267 ++ .../silcbuffer-silc_buffer_pull_tail.html | 267 ++ .../manual/silcbuffer-silc_buffer_purge.html | 257 ++ .../manual/silcbuffer-silc_buffer_push.html | 267 ++ .../silcbuffer-silc_buffer_push_tail.html | 267 ++ .../manual/silcbuffer-silc_buffer_put.html | 263 ++ .../silcbuffer-silc_buffer_put_head.html | 263 ++ .../silcbuffer-silc_buffer_put_tail.html | 263 ++ .../silcbuffer-silc_buffer_realloc.html | 251 ++ .../silcbuffer-silc_buffer_realloc_size.html | 250 ++ .../manual/silcbuffer-silc_buffer_reset.html | 250 ++ .../manual/silcbuffer-silc_buffer_salloc.html | 251 ++ .../silcbuffer-silc_buffer_salloc_size.html | 253 ++ .../manual/silcbuffer-silc_buffer_sclone.html | 253 ++ .../manual/silcbuffer-silc_buffer_scopy.html | 253 ++ .../silcbuffer-silc_buffer_senlarge.html | 258 ++ .../manual/silcbuffer-silc_buffer_set.html | 260 ++ .../silcbuffer-silc_buffer_srealloc.html | 254 ++ .../silcbuffer-silc_buffer_srealloc_size.html | 254 ++ .../manual/silcbuffer-silc_buffer_start.html | 249 ++ .../manual/silcbuffer-silc_buffer_steal.html | 253 ++ .../silcbuffer-silc_buffer_taillen.html | 247 ++ .../silcbuffer-silc_buffer_truelen.html | 247 ++ docs/toolkit/manual/silcbuffer.html | 251 ++ docs/toolkit/manual/silcbuffer.xref | 43 + .../manual/silcbuffmt-SILC_STRFMT_END.html | 240 ++ .../manual/silcbuffmt-SILC_STR_*_CHAR.html | 245 ++ .../manual/silcbuffmt-SILC_STR_*_INT.html | 245 ++ .../manual/silcbuffmt-SILC_STR_*_INT64.html | 245 ++ .../manual/silcbuffmt-SILC_STR_*_NSTRING.html | 271 ++ .../manual/silcbuffmt-SILC_STR_*_SHORT.html | 245 ++ .../manual/silcbuffmt-SILC_STR_*_STRING.html | 271 ++ .../manual/silcbuffmt-SILC_STR_ADVANCE.html | 261 ++ .../manual/silcbuffmt-SILC_STR_BUFFER.html | 251 ++ .../manual/silcbuffmt-SILC_STR_DATA.html | 249 ++ .../manual/silcbuffmt-SILC_STR_END.html | 240 ++ .../manual/silcbuffmt-SILC_STR_FUNC.html | 280 ++ .../manual/silcbuffmt-SILC_STR_OFFSET.html | 251 ++ .../silcbuffmt-SilcBufferFormatFunc.html | 255 ++ .../silcbuffmt-SilcBufferParamType.html | 281 ++ .../silcbuffmt-SilcBufferSFormatFunc.html | 260 ++ .../silcbuffmt-SilcBufferSUnformatFunc.html | 259 ++ .../silcbuffmt-SilcBufferUnformatFunc.html | 254 ++ .../manual/silcbuffmt-silc_buffer_format.html | 288 ++ .../silcbuffmt-silc_buffer_format_vp.html | 240 ++ .../silcbuffmt-silc_buffer_sformat.html | 240 ++ .../silcbuffmt-silc_buffer_sformat_vp.html | 240 ++ .../silcbuffmt-silc_buffer_sstrformat.html | 245 ++ .../silcbuffmt-silc_buffer_strformat.html | 252 ++ .../silcbuffmt-silc_buffer_sunformat.html | 240 ++ .../silcbuffmt-silc_buffer_sunformat_vp.html | 240 ++ .../silcbuffmt-silc_buffer_unformat.html | 253 ++ .../silcbuffmt-silc_buffer_unformat_vp.html | 240 ++ docs/toolkit/manual/silcbuffmt.html | 247 ++ docs/toolkit/manual/silcbuffmt.xref | 35 + .../silcchannel-SilcChannelKeyPayload.html | 231 ++ .../silcchannel-SilcChannelPayload.html | 231 ++ .../silcchannel-silc_channel_get_id.html | 229 ++ ...silcchannel-silc_channel_get_id_parse.html | 230 ++ .../silcchannel-silc_channel_get_mode.html | 230 ++ .../silcchannel-silc_channel_get_name.html | 229 ++ ...lcchannel-silc_channel_key_get_cipher.html | 230 ++ .../silcchannel-silc_channel_key_get_id.html | 230 ++ .../silcchannel-silc_channel_key_get_key.html | 230 ++ ...annel-silc_channel_key_payload_encode.html | 234 ++ ...channel-silc_channel_key_payload_free.html | 228 ++ ...hannel-silc_channel_key_payload_parse.html | 231 ++ ...lcchannel-silc_channel_payload_encode.html | 232 ++ ...silcchannel-silc_channel_payload_free.html | 228 ++ ...hannel-silc_channel_payload_list_free.html | 228 ++ ...ilcchannel-silc_channel_payload_parse.html | 231 ++ ...annel-silc_channel_payload_parse_list.html | 232 ++ docs/toolkit/manual/silcchannel.html | 233 ++ docs/toolkit/manual/silcchannel.xref | 24 + .../toolkit/manual/silccipher-SilcCipher.html | 234 ++ .../manual/silccipher-SilcCipherMode.html | 240 ++ .../manual/silccipher-silc_cipher_alloc.html | 260 ++ .../silccipher-silc_cipher_decrypt.html | 236 ++ .../silccipher-silc_cipher_encrypt.html | 236 ++ .../manual/silccipher-silc_cipher_free.html | 231 ++ .../silccipher-silc_cipher_get_block_len.html | 231 ++ .../manual/silccipher-silc_cipher_get_iv.html | 233 ++ .../silccipher-silc_cipher_get_iv_len.html | 231 ++ .../silccipher-silc_cipher_get_key_len.html | 231 ++ .../silccipher-silc_cipher_get_mode.html | 231 ++ .../silccipher-silc_cipher_get_name.html | 231 ++ .../silccipher-silc_cipher_get_supported.html | 231 ++ .../silccipher-silc_cipher_is_supported.html | 231 ++ .../silccipher-silc_cipher_register.html | 234 ++ ...lccipher-silc_cipher_register_default.html | 233 ++ .../manual/silccipher-silc_cipher_set_iv.html | 236 ++ .../silccipher-silc_cipher_set_key.html | 234 ++ .../silccipher-silc_cipher_unregister.html | 231 ++ ...silccipher-silc_cipher_unregister_all.html | 231 ++ docs/toolkit/manual/silccipher.html | 234 ++ docs/toolkit/manual/silccipher.xref | 27 + .../manual/silcclient-SilcAskPassphrase.html | 286 ++ .../silcclient-SilcChannelPrivateKey.html | 290 ++ .../manual/silcclient-SilcChannelUser.html | 292 ++ .../toolkit/manual/silcclient-SilcClient.html | 301 ++ .../silcclient-SilcClientCommandReply.html | 303 ++ .../silcclient-SilcClientConnectCallback.html | 304 ++ .../silcclient-SilcClientConnection.html | 322 ++ ...silcclient-SilcClientConnectionParams.html | 377 +++ ...silcclient-SilcClientConnectionStatus.html | 295 ++ .../silcclient-SilcClientFileAskName.html | 292 ++ .../silcclient-SilcClientFileError.html | 296 ++ .../silcclient-SilcClientFileMonitor.html | 297 ++ .../manual/silcclient-SilcClientFileName.html | 283 ++ .../silcclient-SilcClientMessageType.html | 290 ++ .../silcclient-SilcClientMonitorStatus.html | 316 ++ .../silcclient-SilcClientOperations.html | 411 +++ .../manual/silcclient-SilcClientParams.html | 355 +++ .../manual/silcclient-SilcClientRunning.html | 282 ++ .../manual/silcclient-SilcClientStats.html | 300 ++ .../manual/silcclient-SilcClientStopped.html | 285 ++ .../manual/silcclient-SilcGetAuthMeth.html | 295 ++ .../silcclient-SilcKeyAgreementCallback.html | 291 ++ .../silcclient-SilcKeyAgreementStatus.html | 294 ++ .../silcclient-SilcPrivateMessageKeys.html | 292 ++ .../silcclient-SilcVerifyPublicKey.html | 282 ++ ...lient-silc_client_abort_key_agreement.html | 288 ++ ...t-silc_client_add_channel_private_key.html | 321 ++ ...t-silc_client_add_private_message_key.html | 305 ++ ...lc_client_add_private_message_key_ske.html | 290 ++ .../manual/silcclient-silc_client_alloc.html | 289 ++ .../silcclient-silc_client_attribute_add.html | 300 ++ .../silcclient-silc_client_attribute_del.html | 290 ++ ...silcclient-silc_client_attributes_get.html | 287 ++ ...client-silc_client_attributes_request.html | 298 ++ ...lcclient-silc_client_close_connection.html | 286 ++ .../silcclient-silc_client_command_call.html | 322 ++ ...ilcclient-silc_client_command_pending.html | 314 ++ .../silcclient-silc_client_command_send.html | 312 ++ ...cclient-silc_client_connect_to_client.html | 302 ++ ...cclient-silc_client_connect_to_server.html | 303 ++ ...lc_client_current_channel_private_key.html | 285 ++ ...t-silc_client_del_channel_private_key.html | 288 ++ ...-silc_client_del_channel_private_keys.html | 284 ++ ...t-silc_client_del_private_message_key.html | 285 ++ .../silcclient-silc_client_file_close.html | 289 ++ .../silcclient-silc_client_file_receive.html | 313 ++ .../silcclient-silc_client_file_send.html | 315 ++ .../manual/silcclient-silc_client_free.html | 282 ++ ...silc_client_free_private_message_keys.html | 282 ++ .../manual/silcclient-silc_client_init.html | 294 ++ .../silcclient-silc_client_key_exchange.html | 337 +++ ...silc_client_list_channel_private_keys.html | 287 ++ ...silc_client_list_private_message_keys.html | 289 ++ ...ilcclient-silc_client_nickname_format.html | 299 ++ ...silcclient-silc_client_nickname_parse.html | 288 ++ .../silcclient-silc_client_on_channel.html | 283 ++ ...ent-silc_client_perform_key_agreement.html | 298 ++ ...c_client_perform_key_agreement_stream.html | 292 ++ ...ilc_client_private_message_key_is_set.html | 284 ++ ...ient-silc_client_private_message_wait.html | 300 ++ ...silc_client_private_message_wait_init.html | 289 ++ ...lc_client_private_message_wait_uninit.html | 286 ++ .../manual/silcclient-silc_client_run.html | 282 ++ .../silcclient-silc_client_run_one.html | 286 ++ ...ient-silc_client_send_channel_message.html | 303 ++ ...client-silc_client_send_key_agreement.html | 329 ++ ...ient-silc_client_send_private_message.html | 295 ++ ...lcclient-silc_client_set_away_message.html | 289 ++ .../manual/silcclient-silc_client_stop.html | 290 ++ docs/toolkit/manual/silcclient.html | 307 ++ docs/toolkit/manual/silcclient.xref | 76 + .../silcclient_entry-SilcChannelEntry.html | 279 ++ .../silcclient_entry-SilcClientEntry.html | 288 ++ ...lcclient_entry-SilcGetChannelCallback.html | 261 ++ ...ilcclient_entry-SilcGetClientCallback.html | 263 ++ ...ilcclient_entry-SilcGetServerCallback.html | 261 ++ .../silcclient_entry-SilcServerEntry.html | 273 ++ ...cclient_entry-silc_client_get_channel.html | 258 ++ ...t_entry-silc_client_get_channel_by_id.html | 257 ++ ...silc_client_get_channel_by_id_resolve.html | 257 ++ ...entry-silc_client_get_channel_resolve.html | 251 ++ ...nt_entry-silc_client_get_client_by_id.html | 256 ++ ...-silc_client_get_client_by_id_resolve.html | 265 ++ ...cclient_entry-silc_client_get_clients.html | 274 ++ ...t_entry-silc_client_get_clients_local.html | 267 ++ ...t_entry-silc_client_get_clients_whois.html | 276 ++ ...lcclient_entry-silc_client_get_server.html | 247 ++ ...nt_entry-silc_client_get_server_by_id.html | 247 ++ ...-silc_client_get_server_by_id_resolve.html | 253 ++ ...ilcclient_entry-silc_client_list_free.html | 247 ++ ...t_entry-silc_client_list_free_channel.html | 247 ++ ...nt_entry-silc_client_list_free_server.html | 247 ++ ...client_entry-silc_client_lock_channel.html | 261 ++ ...cclient_entry-silc_client_lock_client.html | 261 ++ ...cclient_entry-silc_client_lock_server.html | 261 ++ ...cclient_entry-silc_client_ref_channel.html | 249 ++ ...lcclient_entry-silc_client_ref_client.html | 249 ++ ...lcclient_entry-silc_client_ref_server.html | 249 ++ ...ient_entry-silc_client_unlock_channel.html | 244 ++ ...lient_entry-silc_client_unlock_client.html | 244 ++ ...lient_entry-silc_client_unlock_server.html | 244 ++ ...lient_entry-silc_client_unref_channel.html | 246 ++ ...client_entry-silc_client_unref_client.html | 246 ++ ...client_entry-silc_client_unref_server.html | 246 ++ docs/toolkit/manual/silcclient_entry.html | 256 ++ docs/toolkit/manual/silcclient_entry.xref | 40 + docs/toolkit/manual/silcclient_unicode.html | 234 ++ docs/toolkit/manual/silcclient_using.html | 496 +++ docs/toolkit/manual/silcclientlib.html | 242 ++ .../manual/silccommand-SilcCommand.html | 274 ++ .../manual/silccommand-SilcCommandCb.html | 233 ++ .../manual/silccommand-SilcCommandFlags.html | 258 ++ .../silccommand-SilcCommandPayload.html | 232 ++ .../manual/silccommand-silc_command_free.html | 229 ++ .../manual/silccommand-silc_command_get.html | 229 ++ .../silccommand-silc_command_get_args.html | 230 ++ .../silccommand-silc_command_get_ident.html | 232 ++ .../silccommand-silc_command_get_status.html | 236 ++ ...lccommand-silc_command_payload_encode.html | 234 ++ ...d-silc_command_payload_encode_payload.html | 231 ++ ...ommand-silc_command_payload_encode_va.html | 237 ++ ...mmand-silc_command_payload_encode_vap.html | 232 ++ ...ilccommand-silc_command_payload_parse.html | 232 ++ ...-silc_command_reply_payload_encode_va.html | 252 ++ ...silc_command_reply_payload_encode_vap.html | 235 ++ .../silccommand-silc_command_set_command.html | 232 ++ .../silccommand-silc_command_set_ident.html | 232 ++ docs/toolkit/manual/silccommand.html | 232 ++ docs/toolkit/manual/silccommand.xref | 25 + docs/toolkit/manual/silccond-SilcCond.html | 220 ++ .../manual/silccond-silc_cond_alloc.html | 221 ++ .../manual/silccond-silc_cond_broadcast.html | 226 ++ .../manual/silccond-silc_cond_free.html | 219 ++ .../manual/silccond-silc_cond_signal.html | 236 ++ .../manual/silccond-silc_cond_timedwait.html | 225 ++ .../manual/silccond-silc_cond_wait.html | 232 ++ docs/toolkit/manual/silccond.html | 221 ++ docs/toolkit/manual/silccond.xref | 14 + .../silcconfig-SILC_CONFIG_CALLBACK.html | 235 ++ .../manual/silcconfig-SilcConfigCallback.html | 234 ++ .../manual/silcconfig-SilcConfigEntity.html | 230 ++ .../manual/silcconfig-SilcConfigErrno.html | 253 ++ .../manual/silcconfig-SilcConfigFile.html | 232 ++ .../manual/silcconfig-SilcConfigTable.html | 257 ++ .../manual/silcconfig-SilcConfigType.html | 244 ++ .../manual/silcconfig-silc_config_close.html | 233 ++ .../silcconfig-silc_config_get_filename.html | 231 ++ .../silcconfig-silc_config_get_line.html | 229 ++ .../manual/silcconfig-silc_config_init.html | 234 ++ .../manual/silcconfig-silc_config_main.html | 233 ++ .../manual/silcconfig-silc_config_open.html | 232 ++ ...cconfig-silc_config_read_current_line.html | 232 ++ .../silcconfig-silc_config_read_line.html | 236 ++ .../silcconfig-silc_config_register.html | 247 ++ ...silcconfig-silc_config_register_table.html | 246 ++ .../silcconfig-silc_config_strerror.html | 230 ++ docs/toolkit/manual/silcconfig.html | 277 ++ docs/toolkit/manual/silcconfig.xref | 25 + .../manual/silcconnauth-SilcConnAuth.html | 222 ++ .../silcconnauth-SilcConnAuthCompletion.html | 225 ++ .../silcconnauth-SilcConnAuthGetAuthData.html | 237 ++ .../silcconnauth-SilcConnectionType.html | 228 ++ .../silcconnauth-silc_connauth_alloc.html | 224 ++ .../silcconnauth-silc_connauth_free.html | 220 ++ .../silcconnauth-silc_connauth_get_ske.html | 221 ++ .../silcconnauth-silc_connauth_initiator.html | 236 ++ .../silcconnauth-silc_connauth_responder.html | 230 ++ docs/toolkit/manual/silcconnauth.html | 224 ++ docs/toolkit/manual/silcconnauth.xref | 16 + docs/toolkit/manual/silccorelib.html | 239 ++ docs/toolkit/manual/silccryptlib.html | 231 ++ docs/toolkit/manual/silcdh-SilcDH.html | 220 ++ docs/toolkit/manual/silcdh-silc_dh_alloc.html | 225 ++ .../manual/silcdh-silc_dh_compute_key.html | 222 ++ .../manual/silcdh-silc_dh_compute_public.html | 222 ++ docs/toolkit/manual/silcdh-silc_dh_free.html | 220 ++ .../silcdh-silc_dh_generate_private.html | 222 ++ .../silcdh-silc_dh_remote_public(1).html | 221 ++ .../manual/silcdh-silc_dh_remote_public.html | 221 ++ docs/toolkit/manual/silcdh.html | 221 ++ docs/toolkit/manual/silcdh.xref | 15 + docs/toolkit/manual/silcdlist-SilcDList.html | 223 ++ .../manual/silcdlist-silc_dlist_add.html | 223 ++ .../manual/silcdlist-silc_dlist_count.html | 222 ++ .../manual/silcdlist-silc_dlist_del.html | 222 ++ .../manual/silcdlist-silc_dlist_end.html | 223 ++ .../manual/silcdlist-silc_dlist_get.html | 236 ++ .../manual/silcdlist-silc_dlist_init.html | 222 ++ .../manual/silcdlist-silc_dlist_insert.html | 224 ++ .../manual/silcdlist-silc_dlist_start.html | 223 ++ .../manual/silcdlist-silc_dlist_uninit.html | 223 ++ docs/toolkit/manual/silcdlist.html | 230 ++ docs/toolkit/manual/silcdlist.xref | 17 + docs/toolkit/manual/silcdoc_xref | 87 + .../manual/silcexample-SilcExampleStruct.html | 214 ++ .../manual/silcexample-SilcExampleType.html | 222 ++ .../silcexample-silc_example_function.html | 234 ++ docs/toolkit/manual/silcexample.html | 218 ++ docs/toolkit/manual/silcexample.xref | 10 + .../silcfdstream-silc_fd_stream_create.html | 222 ++ .../silcfdstream-silc_fd_stream_create2.html | 223 ++ .../silcfdstream-silc_fd_stream_file.html | 224 ++ .../silcfdstream-silc_fd_stream_file2.html | 222 ++ ...silcfdstream-silc_fd_stream_get_error.html | 218 ++ .../silcfdstream-silc_fd_stream_get_info.html | 220 ++ docs/toolkit/manual/silcfdstream.html | 224 ++ docs/toolkit/manual/silcfdstream.xref | 13 + .../manual/silcfileutil-silc_file_close.html | 221 ++ .../manual/silcfileutil-silc_file_open.html | 223 ++ .../silcfileutil-silc_file_open_mode.html | 223 ++ .../manual/silcfileutil-silc_file_read.html | 221 ++ .../silcfileutil-silc_file_readfile.html | 227 ++ .../silcfileutil-silc_file_set_nonblock.html | 221 ++ .../manual/silcfileutil-silc_file_size.html | 221 ++ .../manual/silcfileutil-silc_file_write.html | 221 ++ .../silcfileutil-silc_file_writefile.html | 223 ++ ...silcfileutil-silc_file_writefile_mode.html | 223 ++ docs/toolkit/manual/silcfileutil.html | 223 ++ docs/toolkit/manual/silcfileutil.xref | 17 + .../toolkit/manual/silcfsm-SILC_FSM_CALL.html | 276 ++ .../silcfsm-SILC_FSM_CALL_CONTINUE.html | 265 ++ .../silcfsm-SILC_FSM_CALL_CONTINUE_SYNC.html | 267 ++ .../manual/silcfsm-SILC_FSM_CONTINUE.html | 267 ++ .../manual/silcfsm-SILC_FSM_EVENT_SIGNAL.html | 269 ++ .../silcfsm-SILC_FSM_EVENT_TIMEDWAIT.html | 283 ++ .../manual/silcfsm-SILC_FSM_EVENT_WAIT.html | 278 ++ .../manual/silcfsm-SILC_FSM_FINISH.html | 256 ++ .../manual/silcfsm-SILC_FSM_STATE.html | 261 ++ .../manual/silcfsm-SILC_FSM_THREAD_WAIT.html | 271 ++ .../toolkit/manual/silcfsm-SILC_FSM_WAIT.html | 255 ++ .../manual/silcfsm-SILC_FSM_YIELD.html | 256 ++ docs/toolkit/manual/silcfsm-SilcFSM.html | 256 ++ .../manual/silcfsm-SilcFSMDestructor.html | 259 ++ docs/toolkit/manual/silcfsm-SilcFSMEvent.html | 255 ++ .../manual/silcfsm-SilcFSMEventStruct.html | 255 ++ .../toolkit/manual/silcfsm-SilcFSMStruct.html | 255 ++ .../toolkit/manual/silcfsm-SilcFSMThread.html | 259 ++ .../silcfsm-SilcFSMThreadDestructor.html | 268 ++ .../manual/silcfsm-SilcFSMThreadStruct.html | 255 ++ .../manual/silcfsm-silc_fsm_alloc.html | 283 ++ .../manual/silcfsm-silc_fsm_continue.html | 258 ++ .../silcfsm-silc_fsm_continue_sync.html | 258 ++ .../manual/silcfsm-silc_fsm_event_alloc.html | 263 ++ .../manual/silcfsm-silc_fsm_event_free.html | 253 ++ .../manual/silcfsm-silc_fsm_event_init.html | 255 ++ .../manual/silcfsm-silc_fsm_finish.html | 261 ++ .../toolkit/manual/silcfsm-silc_fsm_free.html | 262 ++ .../manual/silcfsm-silc_fsm_get_context.html | 256 ++ .../manual/silcfsm-silc_fsm_get_machine.html | 253 ++ .../manual/silcfsm-silc_fsm_get_schedule.html | 265 ++ .../silcfsm-silc_fsm_get_state_context.html | 255 ++ .../toolkit/manual/silcfsm-silc_fsm_init.html | 271 ++ .../manual/silcfsm-silc_fsm_is_started.html | 255 ++ .../toolkit/manual/silcfsm-silc_fsm_next.html | 267 ++ .../manual/silcfsm-silc_fsm_next_later.html | 278 ++ .../manual/silcfsm-silc_fsm_set_context.html | 256 ++ .../silcfsm-silc_fsm_set_state_context.html | 256 ++ .../manual/silcfsm-silc_fsm_start.html | 266 ++ .../manual/silcfsm-silc_fsm_start_sync.html | 260 ++ .../manual/silcfsm-silc_fsm_thread_alloc.html | 299 ++ .../manual/silcfsm-silc_fsm_thread_init.html | 278 ++ docs/toolkit/manual/silcfsm.html | 270 ++ docs/toolkit/manual/silcfsm.xref | 49 + docs/toolkit/manual/silcfsm_i.html | 203 ++ docs/toolkit/manual/silcfsm_i.xref | 6 + docs/toolkit/manual/silchash-SilcHash.html | 236 ++ .../manual/silchash-SilcHashObject.html | 238 ++ .../manual/silchash-silc_hash_alloc.html | 235 ++ .../silchash-silc_hash_alloc_by_oid.html | 235 ++ .../silchash-silc_hash_babbleprint.html | 245 ++ .../manual/silchash-silc_hash_block_len.html | 233 ++ .../manual/silchash-silc_hash_final.html | 237 ++ .../silchash-silc_hash_fingerprint.html | 240 ++ .../manual/silchash-silc_hash_free.html | 233 ++ .../manual/silchash-silc_hash_get_name.html | 233 ++ .../manual/silchash-silc_hash_get_oid.html | 234 ++ .../silchash-silc_hash_get_supported.html | 236 ++ .../manual/silchash-silc_hash_init.html | 241 ++ .../silchash-silc_hash_is_supported.html | 233 ++ .../manual/silchash-silc_hash_len.html | 233 ++ .../manual/silchash-silc_hash_make.html | 237 ++ .../manual/silchash-silc_hash_register.html | 239 ++ .../silchash-silc_hash_register_default.html | 239 ++ .../manual/silchash-silc_hash_transform.html | 237 ++ .../manual/silchash-silc_hash_unregister.html | 235 ++ .../silchash-silc_hash_unregister_all.html | 233 ++ .../manual/silchash-silc_hash_update.html | 249 ++ docs/toolkit/manual/silchash.html | 237 ++ docs/toolkit/manual/silchash.xref | 29 + .../manual/silchashtable-SilcHashCompare.html | 246 ++ .../silchashtable-SilcHashDestructor.html | 245 ++ .../manual/silchashtable-SilcHashForeach.html | 244 ++ .../silchashtable-SilcHashFunction.html | 244 ++ .../manual/silchashtable-SilcHashTable.html | 244 ++ .../silchashtable-SilcHashTableList.html | 265 ++ .../silchashtable-silc_hash_table_add.html | 244 ++ ...silchashtable-silc_hash_table_add_ext.html | 250 ++ .../silchashtable-silc_hash_table_alloc.html | 254 ++ .../silchashtable-silc_hash_table_count.html | 243 ++ .../silchashtable-silc_hash_table_del.html | 243 ++ ...htable-silc_hash_table_del_by_context.html | 245 ++ ...le-silc_hash_table_del_by_context_ext.html | 259 ++ ...silchashtable-silc_hash_table_del_ext.html | 256 ++ .../silchashtable-silc_hash_table_find.html | 246 ++ ...table-silc_hash_table_find_by_context.html | 248 ++ ...e-silc_hash_table_find_by_context_ext.html | 258 ++ ...ilchashtable-silc_hash_table_find_ext.html | 255 ++ ...ashtable-silc_hash_table_find_foreach.html | 256 ++ ...able-silc_hash_table_find_foreach_ext.html | 265 ++ ...silchashtable-silc_hash_table_foreach.html | 251 ++ .../silchashtable-silc_hash_table_free.html | 242 ++ .../silchashtable-silc_hash_table_get.html | 254 ++ .../silchashtable-silc_hash_table_list.html | 252 ++ ...chashtable-silc_hash_table_list_reset.html | 242 ++ .../silchashtable-silc_hash_table_rehash.html | 244 ++ ...chashtable-silc_hash_table_rehash_ext.html | 249 ++ ...silchashtable-silc_hash_table_replace.html | 245 ++ ...hashtable-silc_hash_table_replace_ext.html | 250 ++ .../silchashtable-silc_hash_table_size.html | 242 ++ docs/toolkit/manual/silchashtable.html | 261 ++ docs/toolkit/manual/silchashtable.xref | 37 + docs/toolkit/manual/silchmac-SilcHmac.html | 236 ++ .../manual/silchmac-SilcHmacObject.html | 238 ++ .../manual/silchmac-silc_hmac_alloc.html | 238 ++ .../manual/silchmac-silc_hmac_final.html | 239 ++ .../manual/silchmac-silc_hmac_free.html | 234 ++ .../manual/silchmac-silc_hmac_get_hash.html | 234 ++ .../manual/silchmac-silc_hmac_get_key.html | 235 ++ .../manual/silchmac-silc_hmac_get_name.html | 233 ++ .../silchmac-silc_hmac_get_supported.html | 236 ++ .../manual/silchmac-silc_hmac_init.html | 243 ++ .../silchmac-silc_hmac_init_with_key.html | 235 ++ .../silchmac-silc_hmac_is_supported.html | 233 ++ .../manual/silchmac-silc_hmac_len.html | 233 ++ .../manual/silchmac-silc_hmac_make.html | 239 ++ .../silchmac-silc_hmac_make_truncated.html | 249 ++ .../silchmac-silc_hmac_make_with_key.html | 239 ++ .../manual/silchmac-silc_hmac_register.html | 239 ++ .../silchmac-silc_hmac_register_default.html | 239 ++ .../manual/silchmac-silc_hmac_set_key.html | 238 ++ .../manual/silchmac-silc_hmac_unregister.html | 235 ++ .../silchmac-silc_hmac_unregister_all.html | 233 ++ .../manual/silchmac-silc_hmac_update.html | 250 ++ docs/toolkit/manual/silchmac.html | 237 ++ docs/toolkit/manual/silchmac.xref | 29 + docs/toolkit/manual/silchttplib.html | 217 ++ .../manual/silchttpphp-silc_http_php.html | 215 ++ .../silchttpphp-silc_http_php_file.html | 215 ++ docs/toolkit/manual/silchttpphp.html | 217 ++ docs/toolkit/manual/silchttpphp.xref | 9 + .../silchttpserver-SilcHttpConnection.html | 223 ++ .../manual/silchttpserver-SilcHttpServer.html | 221 ++ ...silchttpserver-SilcHttpServerCallback.html | 237 ++ ...ttpserver-silc_http_server_add_header.html | 232 ++ ...silchttpserver-silc_http_server_alloc.html | 226 ++ .../silchttpserver-silc_http_server_free.html | 220 ++ ...ttpserver-silc_http_server_get_header.html | 224 ++ .../silchttpserver-silc_http_server_send.html | 224 ++ ...ttpserver-silc_http_server_send_error.html | 237 ++ docs/toolkit/manual/silchttpserver.html | 225 ++ docs/toolkit/manual/silchttpserver.xref | 16 + .../silcid-SILC_ID_CHANNEL_COMPARE.html | 243 ++ .../manual/silcid-SILC_ID_CLIENT_COMPARE.html | 243 ++ .../manual/silcid-SILC_ID_COMPARE.html | 243 ++ .../manual/silcid-SILC_ID_COMPARE_HASH.html | 246 ++ .../manual/silcid-SILC_ID_COMPARE_TYPE.html | 245 ++ .../toolkit/manual/silcid-SILC_ID_GET_ID.html | 247 ++ .../manual/silcid-SILC_ID_SERVER_COMPARE.html | 243 ++ docs/toolkit/manual/silcid-SilcChannelID.html | 250 ++ docs/toolkit/manual/silcid-SilcClientID.html | 250 ++ docs/toolkit/manual/silcid-SilcID.html | 252 ++ docs/toolkit/manual/silcid-SilcIDIP.html | 247 ++ docs/toolkit/manual/silcid-SilcIDPayload.html | 242 ++ docs/toolkit/manual/silcid-SilcIdType.html | 248 ++ docs/toolkit/manual/silcid-SilcServerID.html | 250 ++ docs/toolkit/manual/silcid-silc_id_dup.html | 240 ++ .../manual/silcid-silc_id_get_len.html | 239 ++ .../toolkit/manual/silcid-silc_id_id2str.html | 243 ++ .../manual/silcid-silc_id_payload_encode.html | 240 ++ .../silcid-silc_id_payload_encode_data.html | 241 ++ .../manual/silcid-silc_id_payload_free.html | 239 ++ .../silcid-silc_id_payload_get_data.html | 240 ++ .../manual/silcid-silc_id_payload_get_id.html | 240 ++ .../silcid-silc_id_payload_get_len.html | 239 ++ .../silcid-silc_id_payload_get_type.html | 240 ++ .../manual/silcid-silc_id_payload_parse.html | 242 ++ .../silcid-silc_id_payload_parse_id.html | 241 ++ .../toolkit/manual/silcid-silc_id_str2id.html | 243 ++ .../manual/silcid-silc_id_str2id2.html | 241 ++ docs/toolkit/manual/silcid.html | 251 ++ docs/toolkit/manual/silcid.xref | 35 + .../manual/silcidcache-SilcIDCache.html | 232 ++ .../silcidcache-SilcIDCacheDestructor.html | 234 ++ .../manual/silcidcache-SilcIDCacheEntry.html | 239 ++ .../manual/silcidcache-silc_idcache_add.html | 234 ++ .../silcidcache-silc_idcache_alloc.html | 235 ++ .../manual/silcidcache-silc_idcache_del.html | 232 ++ ...lcidcache-silc_idcache_del_by_context.html | 232 ++ .../silcidcache-silc_idcache_del_by_id.html | 232 ++ ...cidcache-silc_idcache_find_by_context.html | 231 ++ .../silcidcache-silc_idcache_find_by_id.html | 245 ++ ...lcidcache-silc_idcache_find_by_id_one.html | 232 ++ ...silcidcache-silc_idcache_find_by_name.html | 232 ++ ...idcache-silc_idcache_find_by_name_one.html | 232 ++ .../manual/silcidcache-silc_idcache_free.html | 229 ++ .../silcidcache-silc_idcache_get_all.html | 231 ++ .../manual/silcidcache-silc_idcache_move.html | 233 ++ .../silcidcache-silc_idcache_update.html | 238 ++ ...dcache-silc_idcache_update_by_context.html | 233 ++ docs/toolkit/manual/silcidcache.html | 235 ++ docs/toolkit/manual/silcidcache.xref | 25 + .../manual/silclist-SILC_LIST_END.html | 226 ++ docs/toolkit/manual/silclist-SilcList.html | 223 ++ .../manual/silclist-silc_list_add.html | 223 ++ .../manual/silclist-silc_list_count.html | 222 ++ .../manual/silclist-silc_list_del.html | 222 ++ .../manual/silclist-silc_list_end.html | 230 ++ .../manual/silclist-silc_list_get.html | 244 ++ .../manual/silclist-silc_list_init.html | 240 ++ .../manual/silclist-silc_list_init_prev.html | 243 ++ .../manual/silclist-silc_list_insert.html | 225 ++ .../manual/silclist-silc_list_start.html | 223 ++ docs/toolkit/manual/silclist.html | 227 ++ docs/toolkit/manual/silclist.xref | 18 + docs/toolkit/manual/silclog-SILC_ASSERT.html | 246 ++ .../manual/silclog-SILC_LOG_DEBUG.html | 256 ++ .../manual/silclog-SILC_LOG_ERROR.html | 246 ++ .../manual/silclog-SILC_LOG_FATAL.html | 246 ++ .../manual/silclog-SILC_LOG_HEXDUMP.html | 265 ++ .../toolkit/manual/silclog-SILC_LOG_INFO.html | 255 ++ .../manual/silclog-SILC_LOG_WARNING.html | 246 ++ docs/toolkit/manual/silclog-SILC_VERIFY.html | 251 ++ docs/toolkit/manual/silclog-SilcLogCb.html | 251 ++ .../manual/silclog-SilcLogDebugCb.html | 251 ++ .../manual/silclog-SilcLogHexdumpCb.html | 256 ++ docs/toolkit/manual/silclog-SilcLogType.html | 245 ++ .../manual/silclog-silc_log_debug.html | 244 ++ .../silclog-silc_log_debug_hexdump.html | 244 ++ .../manual/silclog-silc_log_flush_all.html | 243 ++ .../manual/silclog-silc_log_flushdelay.html | 237 ++ .../manual/silclog-silc_log_get_file.html | 243 ++ .../manual/silclog-silc_log_quick.html | 248 ++ .../manual/silclog-silc_log_reset_all.html | 241 ++ .../silclog-silc_log_reset_callbacks.html | 239 ++ ...ilclog-silc_log_reset_debug_callbacks.html | 237 ++ .../manual/silclog-silc_log_set_callback.html | 251 ++ .../silclog-silc_log_set_debug_callbacks.html | 250 ++ .../silclog-silc_log_set_debug_string.html | 239 ++ .../manual/silclog-silc_log_set_file.html | 247 ++ .../manual/silclog-silc_log_timestamp.html | 238 ++ docs/toolkit/manual/silclog.html | 239 ++ docs/toolkit/manual/silclog.xref | 33 + docs/toolkit/manual/silclog_i.html | 203 ++ docs/toolkit/manual/silclog_i.xref | 6 + .../manual/silcmath-silc_math_gen_prime.html | 222 ++ .../manual/silcmath-silc_math_prime_test.html | 214 ++ docs/toolkit/manual/silcmath.html | 216 ++ docs/toolkit/manual/silcmath.xref | 9 + docs/toolkit/manual/silcmathlib.html | 218 ++ .../manual/silcmemory-silc_calloc.html | 226 ++ docs/toolkit/manual/silcmemory-silc_free.html | 224 ++ .../manual/silcmemory-silc_malloc.html | 225 ++ .../manual/silcmemory-silc_memdup.html | 227 ++ .../manual/silcmemory-silc_realloc.html | 234 ++ .../manual/silcmemory-silc_scalloc.html | 235 ++ .../manual/silcmemory-silc_smalloc.html | 238 ++ .../manual/silcmemory-silc_smalloc_ua.html | 237 ++ .../manual/silcmemory-silc_smemdup.html | 238 ++ .../manual/silcmemory-silc_srealloc.html | 245 ++ .../manual/silcmemory-silc_srealloc_ua.html | 233 ++ .../manual/silcmemory-silc_sstrdup.html | 235 ++ docs/toolkit/manual/silcmemory.html | 226 ++ docs/toolkit/manual/silcmemory.xref | 19 + .../manual/silcmessage-SilcMessageFlags.html | 244 ++ .../silcmessage-SilcMessagePayload.html | 228 ++ .../silcmessage-silc_message_get_data.html | 226 ++ .../silcmessage-silc_message_get_flags.html | 223 ++ .../silcmessage-silc_message_get_mac.html | 225 ++ ...cmessage-silc_message_payload_decrypt.html | 248 ++ ...lcmessage-silc_message_payload_encode.html | 268 ++ ...cmessage-silc_message_payload_encrypt.html | 241 ++ ...silcmessage-silc_message_payload_free.html | 223 ++ ...ilcmessage-silc_message_payload_parse.html | 259 ++ ...ge-silc_message_signed_get_public_key.html | 230 ++ ...ilcmessage-silc_message_signed_verify.html | 229 ++ docs/toolkit/manual/silcmessage.html | 228 ++ docs/toolkit/manual/silcmessage.xref | 19 + docs/toolkit/manual/silcmessage_i.html | 203 ++ docs/toolkit/manual/silcmessage_i.xref | 6 + docs/toolkit/manual/silcmime-SilcMime.html | 234 ++ .../manual/silcmime-SilcMimeAssembler.html | 234 ++ .../manual/silcmime-silc_mime_add_data.html | 233 ++ .../manual/silcmime-silc_mime_add_field.html | 242 ++ .../silcmime-silc_mime_add_multipart.html | 253 ++ .../manual/silcmime-silc_mime_alloc.html | 232 ++ .../manual/silcmime-silc_mime_assemble.html | 251 ++ .../silcmime-silc_mime_assembler_alloc.html | 232 ++ .../silcmime-silc_mime_assembler_free.html | 232 ++ .../manual/silcmime-silc_mime_decode.html | 251 ++ .../manual/silcmime-silc_mime_encode.html | 238 ++ .../silcmime-silc_mime_encode_partial.html | 239 ++ .../manual/silcmime-silc_mime_free.html | 232 ++ .../manual/silcmime-silc_mime_get_data.html | 233 ++ .../manual/silcmime-silc_mime_get_field.html | 233 ++ .../silcmime-silc_mime_get_multiparts.html | 236 ++ .../silcmime-silc_mime_is_multipart.html | 233 ++ .../manual/silcmime-silc_mime_is_partial.html | 232 ++ .../silcmime-silc_mime_partial_free.html | 233 ++ .../silcmime-silc_mime_set_multipart.html | 235 ++ .../manual/silcmime-silc_mime_steal_data.html | 235 ++ docs/toolkit/manual/silcmime.html | 238 ++ docs/toolkit/manual/silcmime.xref | 28 + docs/toolkit/manual/silcmime_i.html | 203 ++ docs/toolkit/manual/silcmime_i.xref | 6 + .../toolkit/manual/silcmode-ChannelModes.html | 224 ++ .../manual/silcmode-ChannelUserModes.html | 222 ++ .../toolkit/manual/silcmode-SilcUserMode.html | 225 ++ docs/toolkit/manual/silcmode.html | 216 ++ docs/toolkit/manual/silcmode.xref | 10 + docs/toolkit/manual/silcmp-SilcMPInt.html | 261 ++ docs/toolkit/manual/silcmp-silc_mp_abs.html | 256 ++ docs/toolkit/manual/silcmp-silc_mp_add.html | 256 ++ .../toolkit/manual/silcmp-silc_mp_add_ui.html | 257 ++ docs/toolkit/manual/silcmp-silc_mp_and.html | 256 ++ .../toolkit/manual/silcmp-silc_mp_bin2mp.html | 258 ++ docs/toolkit/manual/silcmp-silc_mp_cmp.html | 257 ++ .../toolkit/manual/silcmp-silc_mp_cmp_si.html | 257 ++ .../toolkit/manual/silcmp-silc_mp_cmp_ui.html | 258 ++ docs/toolkit/manual/silcmp-silc_mp_div.html | 257 ++ .../manual/silcmp-silc_mp_div_2exp.html | 257 ++ .../manual/silcmp-silc_mp_div_2exp_qr.html | 260 ++ .../toolkit/manual/silcmp-silc_mp_div_qr.html | 260 ++ .../toolkit/manual/silcmp-silc_mp_div_ui.html | 257 ++ docs/toolkit/manual/silcmp-silc_mp_gcd.html | 257 ++ .../toolkit/manual/silcmp-silc_mp_gcdext.html | 258 ++ .../manual/silcmp-silc_mp_get_str.html | 265 ++ .../toolkit/manual/silcmp-silc_mp_get_ui.html | 256 ++ docs/toolkit/manual/silcmp-silc_mp_init.html | 258 ++ docs/toolkit/manual/silcmp-silc_mp_mod.html | 259 ++ .../manual/silcmp-silc_mp_mod_2exp.html | 259 ++ .../toolkit/manual/silcmp-silc_mp_mod_ui.html | 258 ++ .../toolkit/manual/silcmp-silc_mp_modinv.html | 271 ++ .../toolkit/manual/silcmp-silc_mp_mp2bin.html | 259 ++ .../manual/silcmp-silc_mp_mp2bin_noalloc.html | 258 ++ docs/toolkit/manual/silcmp-silc_mp_mul.html | 256 ++ .../manual/silcmp-silc_mp_mul_2exp.html | 257 ++ .../toolkit/manual/silcmp-silc_mp_mul_ui.html | 257 ++ docs/toolkit/manual/silcmp-silc_mp_neg.html | 256 ++ docs/toolkit/manual/silcmp-silc_mp_or.html | 256 ++ docs/toolkit/manual/silcmp-silc_mp_pow.html | 257 ++ .../manual/silcmp-silc_mp_pow_mod.html | 258 ++ .../manual/silcmp-silc_mp_pow_mod_ui.html | 258 ++ .../toolkit/manual/silcmp-silc_mp_pow_ui.html | 257 ++ docs/toolkit/manual/silcmp-silc_mp_set.html | 257 ++ .../toolkit/manual/silcmp-silc_mp_set_si.html | 257 ++ .../manual/silcmp-silc_mp_set_str.html | 264 ++ .../toolkit/manual/silcmp-silc_mp_set_ui.html | 257 ++ docs/toolkit/manual/silcmp-silc_mp_size.html | 256 ++ .../manual/silcmp-silc_mp_sizeinbase.html | 267 ++ docs/toolkit/manual/silcmp-silc_mp_sqrt.html | 256 ++ docs/toolkit/manual/silcmp-silc_mp_sub.html | 256 ++ .../toolkit/manual/silcmp-silc_mp_sub_ui.html | 257 ++ .../toolkit/manual/silcmp-silc_mp_uninit.html | 256 ++ docs/toolkit/manual/silcmp-silc_mp_xor.html | 256 ++ docs/toolkit/manual/silcmp.html | 261 ++ docs/toolkit/manual/silcmp.xref | 52 + docs/toolkit/manual/silcmutex-SilcMutex.html | 225 ++ docs/toolkit/manual/silcmutex-SilcRwLock.html | 225 ++ .../manual/silcmutex-silc_mutex_alloc.html | 227 ++ .../silcmutex-silc_mutex_assert_locked.html | 225 ++ .../manual/silcmutex-silc_mutex_free.html | 224 ++ .../manual/silcmutex-silc_mutex_lock.html | 234 ++ .../manual/silcmutex-silc_mutex_unlock.html | 232 ++ .../manual/silcmutex-silc_rwlock_alloc.html | 226 ++ .../manual/silcmutex-silc_rwlock_free.html | 224 ++ .../manual/silcmutex-silc_rwlock_rdlock.html | 228 ++ .../manual/silcmutex-silc_rwlock_unlock.html | 226 ++ .../manual/silcmutex-silc_rwlock_wrlock.html | 228 ++ docs/toolkit/manual/silcmutex.html | 226 ++ docs/toolkit/manual/silcmutex.xref | 19 + .../manual/silcnet-SilcNetCallback.html | 255 ++ .../manual/silcnet-SilcNetListener.html | 246 ++ .../silcnet-SilcNetResolveCallback.html | 247 ++ .../toolkit/manual/silcnet-SilcNetStatus.html | 257 ++ .../silcnet-silc_net_accept_connection.html | 246 ++ .../manual/silcnet-silc_net_addr2bin.html | 247 ++ .../silcnet-silc_net_check_host_by_sock.html | 246 ++ .../silcnet-silc_net_check_local_by_sock.html | 246 ++ .../silcnet-silc_net_close_connection.html | 245 ++ .../silcnet-silc_net_close_listener.html | 244 ++ .../silcnet-silc_net_get_error_string.html | 244 ++ .../silcnet-silc_net_get_local_port.html | 244 ++ .../silcnet-silc_net_get_remote_port.html | 244 ++ .../silcnet-silc_net_get_socket_opt.html | 247 ++ .../silcnet-silc_net_gethostbyaddr.html | 246 ++ .../silcnet-silc_net_gethostbyaddr_async.html | 250 ++ .../silcnet-silc_net_gethostbyname.html | 251 ++ .../silcnet-silc_net_gethostbyname_async.html | 255 ++ .../manual/silcnet-silc_net_is_ip.html | 245 ++ .../manual/silcnet-silc_net_is_ip4.html | 244 ++ .../manual/silcnet-silc_net_is_ip6.html | 244 ++ ...ilcnet-silc_net_listener_get_hostname.html | 247 ++ .../silcnet-silc_net_listener_get_ip.html | 247 ++ .../silcnet-silc_net_listener_get_port.html | 248 ++ .../manual/silcnet-silc_net_localhost.html | 247 ++ .../manual/silcnet-silc_net_localip.html | 244 ++ .../silcnet-silc_net_set_socket_nonblock.html | 244 ++ .../silcnet-silc_net_set_socket_opt.html | 247 ++ .../manual/silcnet-silc_net_tcp_connect.html | 261 ++ .../silcnet-silc_net_tcp_create_listener.html | 261 ++ .../manual/silcnet-silc_net_udp_connect.html | 284 ++ .../manual/silcnet-silc_net_udp_receive.html | 251 ++ .../manual/silcnet-silc_net_udp_send.html | 255 ++ docs/toolkit/manual/silcnet.html | 248 ++ docs/toolkit/manual/silcnet.xref | 40 + docs/toolkit/manual/silcnet_i.html | 203 ++ docs/toolkit/manual/silcnet_i.xref | 6 + .../manual/silcnotify-SilcNotifyPayload.html | 223 ++ .../manual/silcnotify-SilcNotifyType.html | 244 ++ .../silcnotify-silc_notify_get_arg_num.html | 220 ++ .../silcnotify-silc_notify_get_args.html | 221 ++ .../silcnotify-silc_notify_get_type.html | 220 ++ ...silcnotify-silc_notify_payload_encode.html | 224 ++ ...otify-silc_notify_payload_encode_args.html | 223 ++ .../silcnotify-silc_notify_payload_free.html | 220 ++ .../silcnotify-silc_notify_payload_parse.html | 223 ++ docs/toolkit/manual/silcnotify.html | 223 ++ docs/toolkit/manual/silcnotify.xref | 16 + .../toolkit/manual/silcpacket-SilcPacket.html | 284 ++ .../silcpacket-SilcPacketCallbacks.html | 269 ++ .../manual/silcpacket-SilcPacketEngine.html | 260 ++ .../manual/silcpacket-SilcPacketEosCb.html | 266 ++ .../manual/silcpacket-SilcPacketError.html | 276 ++ .../manual/silcpacket-SilcPacketErrorCb.html | 265 ++ .../manual/silcpacket-SilcPacketFlags.html | 273 ++ .../silcpacket-SilcPacketReceiveCb.html | 297 ++ .../manual/silcpacket-SilcPacketStream.html | 260 ++ .../manual/silcpacket-SilcPacketType.html | 299 ++ .../silcpacket-SilcPacketWrapCoder.html | 281 ++ ...-silc_packet_engine_free_streams_list.html | 259 ++ ...packet-silc_packet_engine_get_streams.html | 268 ++ .../silcpacket-silc_packet_engine_start.html | 274 ++ .../silcpacket-silc_packet_engine_stop.html | 260 ++ .../silcpacket-silc_packet_error_string.html | 259 ++ .../manual/silcpacket-silc_packet_free.html | 261 ++ .../silcpacket-silc_packet_get_context.html | 259 ++ .../silcpacket-silc_packet_get_engine.html | 259 ++ .../silcpacket-silc_packet_get_ids.html | 263 ++ .../silcpacket-silc_packet_get_keys.html | 264 ++ .../silcpacket-silc_packet_get_sender.html | 264 ++ .../manual/silcpacket-silc_packet_send.html | 269 ++ .../silcpacket-silc_packet_send_ext.html | 269 ++ .../silcpacket-silc_packet_send_va.html | 276 ++ .../silcpacket-silc_packet_send_va_ext.html | 268 ++ .../silcpacket-silc_packet_set_context.html | 265 ++ .../silcpacket-silc_packet_set_ids.html | 266 ++ .../silcpacket-silc_packet_set_keys.html | 270 ++ .../silcpacket-silc_packet_set_sid.html | 269 ++ ...cpacket-silc_packet_stream_add_remote.html | 297 ++ .../silcpacket-silc_packet_stream_create.html | 281 ++ ...silcpacket-silc_packet_stream_destroy.html | 260 ++ ...cpacket-silc_packet_stream_get_stream.html | 264 ++ .../silcpacket-silc_packet_stream_inject.html | 263 ++ .../silcpacket-silc_packet_stream_is_udp.html | 260 ++ ...ilcpacket-silc_packet_stream_is_valid.html | 260 ++ .../silcpacket-silc_packet_stream_link.html | 290 ++ .../silcpacket-silc_packet_stream_ref.html | 261 ++ ...et-silc_packet_stream_set_iv_included.html | 268 ++ ...cpacket-silc_packet_stream_set_router.html | 262 ++ ...cpacket-silc_packet_stream_set_stream.html | 264 ++ .../silcpacket-silc_packet_stream_unlink.html | 263 ++ .../silcpacket-silc_packet_stream_unref.html | 260 ++ .../silcpacket-silc_packet_stream_wrap.html | 299 ++ .../manual/silcpacket-silc_packet_wait.html | 299 ++ .../silcpacket-silc_packet_wait_init.html | 291 ++ .../silcpacket-silc_packet_wait_uninit.html | 261 ++ docs/toolkit/manual/silcpacket.html | 266 ++ docs/toolkit/manual/silcpacket.xref | 55 + .../silcpk-SilcPublicKeyIdentifier.html | 231 ++ .../manual/silcpk-SilcSILCPrivateKey.html | 225 ++ .../manual/silcpk-SilcSILCPublicKey.html | 228 ++ ...lcpk-silc_pkcs_silc_decode_identifier.html | 221 ++ ...lcpk-silc_pkcs_silc_encode_identifier.html | 224 ++ .../silcpk-silc_pkcs_silc_generate_key.html | 233 ++ ...cpk-silc_pkcs_silc_public_key_version.html | 220 ++ docs/toolkit/manual/silcpk.html | 220 ++ docs/toolkit/manual/silcpk.xref | 14 + docs/toolkit/manual/silcpk_i.html | 203 ++ docs/toolkit/manual/silcpk_i.xref | 6 + .../manual/silcpkcs-SilcPKCSFileEncoding.html | 252 ++ .../toolkit/manual/silcpkcs-SilcPKCSType.html | 255 ++ .../manual/silcpkcs-SilcPrivateKey.html | 252 ++ .../manual/silcpkcs-SilcPublicKey.html | 255 ++ ...silcpkcs-silc_pkcs_algorithm_register.html | 248 ++ ...lcpkcs-silc_pkcs_algorithm_unregister.html | 246 ++ .../manual/silcpkcs-silc_pkcs_decrypt.html | 249 ++ .../manual/silcpkcs-silc_pkcs_encrypt.html | 249 ++ .../silcpkcs-silc_pkcs_find_algorithm.html | 248 ++ .../manual/silcpkcs-silc_pkcs_find_pkcs.html | 246 ++ .../silcpkcs-silc_pkcs_get_algorithm.html | 247 ++ .../silcpkcs-silc_pkcs_get_context.html | 250 ++ .../manual/silcpkcs-silc_pkcs_get_name.html | 247 ++ .../manual/silcpkcs-silc_pkcs_get_pkcs.html | 247 ++ .../silcpkcs-silc_pkcs_get_supported.html | 246 ++ .../manual/silcpkcs-silc_pkcs_get_type.html | 247 ++ .../silcpkcs-silc_pkcs_load_private_key.html | 251 ++ .../silcpkcs-silc_pkcs_load_public_key.html | 248 ++ .../silcpkcs-silc_pkcs_private_key_alloc.html | 251 ++ .../silcpkcs-silc_pkcs_private_key_free.html | 246 ++ ...ilcpkcs-silc_pkcs_private_key_get_len.html | 246 ++ .../silcpkcs-silc_pkcs_public_key_alloc.html | 253 ++ ...silcpkcs-silc_pkcs_public_key_compare.html | 248 ++ .../silcpkcs-silc_pkcs_public_key_copy.html | 247 ++ .../silcpkcs-silc_pkcs_public_key_export.html | 248 ++ .../silcpkcs-silc_pkcs_public_key_free.html | 246 ++ ...silcpkcs-silc_pkcs_public_key_get_len.html | 246 ++ .../manual/silcpkcs-silc_pkcs_register.html | 252 ++ .../silcpkcs-silc_pkcs_register_default.html | 248 ++ .../silcpkcs-silc_pkcs_save_private_key.html | 253 ++ .../silcpkcs-silc_pkcs_save_public_key.html | 249 ++ .../manual/silcpkcs-silc_pkcs_sign.html | 252 ++ .../manual/silcpkcs-silc_pkcs_unregister.html | 246 ++ .../silcpkcs-silc_pkcs_unregister_all.html | 246 ++ .../manual/silcpkcs-silc_pkcs_verify.html | 255 ++ docs/toolkit/manual/silcpkcs.html | 250 ++ docs/toolkit/manual/silcpkcs.xref | 42 + .../manual/silcpkcs1-SilcPkcs1BlockType.html | 222 ++ .../manual/silcpkcs1-silc_pkcs1_decode.html | 224 ++ .../manual/silcpkcs1-silc_pkcs1_encode.html | 228 ++ docs/toolkit/manual/silcpkcs1.html | 219 ++ docs/toolkit/manual/silcpkcs1.xref | 10 + docs/toolkit/manual/silcpkcs1_i.html | 203 ++ docs/toolkit/manual/silcpkcs1_i.xref | 6 + ...pubkey-silc_public_key_payload_decode.html | 217 ++ ...pubkey-silc_public_key_payload_encode.html | 215 ++ docs/toolkit/manual/silcpubkey.html | 216 ++ docs/toolkit/manual/silcpubkey.xref | 9 + docs/toolkit/manual/silcrng-SilcRng.html | 234 ++ .../manual/silcrng-silc_rng_add_noise.html | 233 ++ .../manual/silcrng-silc_rng_alloc.html | 234 ++ .../toolkit/manual/silcrng-silc_rng_free.html | 232 ++ .../manual/silcrng-silc_rng_get_byte.html | 231 ++ .../silcrng-silc_rng_get_byte_fast.html | 241 ++ .../manual/silcrng-silc_rng_get_rn16.html | 231 ++ .../manual/silcrng-silc_rng_get_rn32.html | 231 ++ .../manual/silcrng-silc_rng_get_rn_data.html | 233 ++ .../silcrng-silc_rng_get_rn_string.html | 233 ++ .../silcrng-silc_rng_global_add_noise.html | 233 ++ .../silcrng-silc_rng_global_get_byte.html | 231 ++ ...silcrng-silc_rng_global_get_byte_fast.html | 241 ++ .../silcrng-silc_rng_global_get_rn16.html | 231 ++ .../silcrng-silc_rng_global_get_rn32.html | 231 ++ .../silcrng-silc_rng_global_get_rn_data.html | 233 ++ ...silcrng-silc_rng_global_get_rn_string.html | 233 ++ .../manual/silcrng-silc_rng_global_init.html | 246 ++ .../silcrng-silc_rng_global_uninit.html | 232 ++ .../toolkit/manual/silcrng-silc_rng_init.html | 241 ++ docs/toolkit/manual/silcrng.html | 240 ++ docs/toolkit/manual/silcrng.xref | 27 + docs/toolkit/manual/silcrng_intro.html | 365 +++ .../manual/silcschedule-SILC_ALL_TASKS.html | 241 ++ .../silcschedule-SILC_TASK_CALLBACK.html | 243 ++ .../manual/silcschedule-SilcSchedule.html | 240 ++ .../toolkit/manual/silcschedule-SilcTask.html | 239 ++ .../manual/silcschedule-SilcTaskCallback.html | 258 ++ .../manual/silcschedule-SilcTaskEvent.html | 252 ++ .../manual/silcschedule-SilcTaskNotifyCb.html | 264 ++ .../manual/silcschedule-silc_schedule.html | 250 ++ ...ilcschedule-silc_schedule_get_context.html | 240 ++ ...cschedule-silc_schedule_get_fd_events.html | 239 ++ .../silcschedule-silc_schedule_init.html | 247 ++ .../silcschedule-silc_schedule_one.html | 247 ++ ...cschedule-silc_schedule_set_listen_fd.html | 255 ++ ...silcschedule-silc_schedule_set_notify.html | 239 ++ .../silcschedule-silc_schedule_stop.html | 242 ++ ...ilcschedule-silc_schedule_task_add_fd.html | 248 ++ ...chedule-silc_schedule_task_add_signal.html | 253 ++ ...hedule-silc_schedule_task_add_timeout.html | 244 ++ .../silcschedule-silc_schedule_task_del.html | 244 ++ ...chedule-silc_schedule_task_del_by_all.html | 244 ++ ...le-silc_schedule_task_del_by_callback.html | 244 ++ ...ule-silc_schedule_task_del_by_context.html | 243 ++ ...schedule-silc_schedule_task_del_by_fd.html | 243 ++ .../silcschedule-silc_schedule_uninit.html | 240 ++ ...chedule-silc_schedule_unset_listen_fd.html | 239 ++ .../silcschedule-silc_schedule_wakeup.html | 241 ++ docs/toolkit/manual/silcschedule.html | 274 ++ docs/toolkit/manual/silcschedule.xref | 33 + docs/toolkit/manual/silcschedule_i.html | 203 ++ docs/toolkit/manual/silcschedule_i.xref | 6 + .../toolkit/manual/silcserver-SilcServer.html | 220 ++ .../manual/silcserver-SilcServerRunning.html | 221 ++ .../manual/silcserver-SilcServerStop.html | 218 ++ .../manual/silcserver-silc_server_alloc.html | 226 ++ .../manual/silcserver-silc_server_free.html | 218 ++ .../manual/silcserver-silc_server_run(1).html | 222 ++ .../manual/silcserver-silc_server_run.html | 222 ++ docs/toolkit/manual/silcserver.html | 218 ++ docs/toolkit/manual/silcserver.xref | 14 + ...r_params-silc_server_params_add_admin.html | 226 ++ ..._params-silc_server_params_add_cipher.html | 226 ++ ..._params-silc_server_params_add_client.html | 226 ++ ...rams-silc_server_params_add_connparam.html | 226 ++ ...er_params-silc_server_params_add_deny.html | 226 ++ ...er_params-silc_server_params_add_hash.html | 226 ++ ...er_params-silc_server_params_add_hmac.html | 226 ++ ...er_params-silc_server_params_add_pkcs.html | 226 ++ ..._params-silc_server_params_add_router.html | 226 ++ ..._params-silc_server_params_add_server.html | 226 ++ ...erver_params-silc_server_params_alloc.html | 225 ++ ...server_params-silc_server_params_free.html | 225 ++ ...ilc_server_params_serverinfo_alloc(1).html | 226 ++ ...s-silc_server_params_serverinfo_alloc.html | 228 ++ ...ams-silc_server_params_set_serverinfo.html | 228 ++ docs/toolkit/manual/silcserver_params.html | 232 ++ docs/toolkit/manual/silcserver_params.xref | 21 + docs/toolkit/manual/silcsftp-SilcSFTP.html | 257 ++ .../manual/silcsftp-SilcSFTPAttrCallback.html | 258 ++ .../manual/silcsftp-SilcSFTPAttributes.html | 255 ++ .../manual/silcsftp-SilcSFTPDataCallback.html | 259 ++ .../silcsftp-SilcSFTPErrorCallback.html | 259 ++ .../silcsftp-SilcSFTPExtendedCallback.html | 259 ++ .../silcsftp-SilcSFTPFileOperation.html | 265 ++ .../manual/silcsftp-SilcSFTPHandle.html | 255 ++ .../silcsftp-SilcSFTPHandleCallback.html | 260 ++ .../manual/silcsftp-SilcSFTPMonitor.html | 258 ++ .../manual/silcsftp-SilcSFTPMonitorData.html | 269 ++ .../manual/silcsftp-SilcSFTPMonitors.html | 278 ++ .../toolkit/manual/silcsftp-SilcSFTPName.html | 256 ++ .../manual/silcsftp-SilcSFTPNameCallback.html | 259 ++ .../manual/silcsftp-SilcSFTPStatus.html | 288 ++ .../silcsftp-SilcSFTPStatusCallback.html | 261 ++ .../manual/silcsftp-SilcSFTPVersion.html | 253 ++ .../silcsftp-SilcSFTPVersionCallback.html | 258 ++ .../silcsftp-silc_sftp_client_shutdown.html | 255 ++ .../silcsftp-silc_sftp_client_start.html | 263 ++ .../manual/silcsftp-silc_sftp_close.html | 257 ++ .../manual/silcsftp-silc_sftp_extended.html | 260 ++ .../manual/silcsftp-silc_sftp_fsetstat.html | 259 ++ .../manual/silcsftp-silc_sftp_fstat.html | 257 ++ .../manual/silcsftp-silc_sftp_lstat.html | 258 ++ .../manual/silcsftp-silc_sftp_mkdir.html | 259 ++ .../manual/silcsftp-silc_sftp_open.html | 260 ++ .../manual/silcsftp-silc_sftp_opendir.html | 257 ++ .../manual/silcsftp-silc_sftp_read.html | 260 ++ .../manual/silcsftp-silc_sftp_readdir.html | 257 ++ .../manual/silcsftp-silc_sftp_readlink.html | 257 ++ .../manual/silcsftp-silc_sftp_realpath.html | 257 ++ .../manual/silcsftp-silc_sftp_remove.html | 257 ++ .../manual/silcsftp-silc_sftp_rename.html | 258 ++ .../manual/silcsftp-silc_sftp_rmdir.html | 257 ++ ...silcsftp-silc_sftp_server_set_monitor.html | 258 ++ .../silcsftp-silc_sftp_server_shutdown.html | 255 ++ .../silcsftp-silc_sftp_server_start.html | 262 ++ .../manual/silcsftp-silc_sftp_setstat.html | 259 ++ .../manual/silcsftp-silc_sftp_stat.html | 258 ++ .../manual/silcsftp-silc_sftp_symlink.html | 259 ++ .../manual/silcsftp-silc_sftp_write.html | 261 ++ docs/toolkit/manual/silcsftp.html | 267 ++ docs/toolkit/manual/silcsftp.xref | 49 + .../silcsftp_fs-SilcSFTPFSMemoryPerm.html | 229 ++ .../silcsftp_fs-SilcSFTPFilesystem.html | 229 ++ .../silcsftp_fs-SilcSFTPFilesystemOps.html | 397 +++ ...lcsftp_fs-silc_sftp_fs_memory_add_dir.html | 229 ++ ...csftp_fs-silc_sftp_fs_memory_add_file.html | 231 ++ ...silcsftp_fs-silc_sftp_fs_memory_alloc.html | 224 ++ ...lcsftp_fs-silc_sftp_fs_memory_del_dir.html | 226 ++ ...csftp_fs-silc_sftp_fs_memory_del_file.html | 225 ++ .../silcsftp_fs-silc_sftp_fs_memory_free.html | 220 ++ docs/toolkit/manual/silcsftp_fs.html | 266 ++ docs/toolkit/manual/silcsftp_fs.xref | 16 + docs/toolkit/manual/silcsftplib.html | 219 ++ docs/toolkit/manual/silcsim.html | 203 ++ docs/toolkit/manual/silcsim.xref | 6 + docs/toolkit/manual/silcsimutil.html | 203 ++ docs/toolkit/manual/silcsimutil.xref | 6 + .../manual/silcske-SilcSKECompletionCb.html | 255 ++ .../manual/silcske-SilcSKEKeyMaterial.html | 252 ++ .../toolkit/manual/silcske-SilcSKEPKType.html | 246 ++ .../toolkit/manual/silcske-SilcSKEParams.html | 279 ++ .../manual/silcske-SilcSKERekeyMaterial.html | 242 ++ .../silcske-SilcSKESecurityProperties.html | 252 ++ .../silcske-SilcSKESecurityPropertyFlag.html | 245 ++ .../toolkit/manual/silcske-SilcSKEStatus.html | 265 ++ .../manual/silcske-SilcSKEVerifyCb.html | 249 ++ .../silcske-SilcSKEVerifyCbCompletion.html | 241 ++ .../manual/silcske-silc_ske_alloc.html | 270 ++ .../toolkit/manual/silcske-silc_ske_free.html | 237 ++ .../silcske-silc_ske_free_key_material.html | 238 ++ .../silcske-silc_ske_free_rekey_material.html | 238 ++ .../manual/silcske-silc_ske_get_context.html | 237 ++ .../silcske-silc_ske_get_key_material.html | 239 ++ ...cske-silc_ske_get_security_properties.html | 239 ++ .../manual/silcske-silc_ske_initiator.html | 259 ++ .../manual/silcske-silc_ske_map_status.html | 237 ++ .../silcske-silc_ske_parse_version.html | 243 ++ ...ke-silc_ske_process_key_material_data.html | 240 ++ .../silcske-silc_ske_rekey_initiator.html | 251 ++ .../silcske-silc_ske_rekey_responder.html | 256 ++ .../manual/silcske-silc_ske_responder.html | 252 ++ .../silcske-silc_ske_set_callbacks.html | 255 ++ .../manual/silcske-silc_ske_set_keys.html | 248 ++ docs/toolkit/manual/silcske.html | 245 ++ docs/toolkit/manual/silcske.xref | 33 + ...cske_groups-SilcSKEDiffieHellmanGroup.html | 221 ++ ..._groups-silc_ske_get_supported_groups.html | 221 ++ .../silcske_groups-silc_ske_group_free.html | 218 ++ ...ske_groups-silc_ske_group_get_by_name.html | 222 ++ ...e_groups-silc_ske_group_get_by_number.html | 222 ++ ...ilcske_groups-silc_ske_group_get_name.html | 218 ++ ...cske_groups-silc_ske_group_get_number.html | 218 ++ docs/toolkit/manual/silcske_groups.html | 222 ++ docs/toolkit/manual/silcske_groups.xref | 14 + docs/toolkit/manual/silcske_i.html | 203 ++ docs/toolkit/manual/silcske_i.xref | 6 + .../silcske_payload-SilcSKEKEPayload.html | 221 ++ .../silcske_payload-SilcSKEStartPayload.html | 221 ++ ...ke_payload-silc_ske_payload_ke_decode.html | 224 ++ ...ke_payload-silc_ske_payload_ke_encode.html | 223 ++ ...cske_payload-silc_ske_payload_ke_free.html | 219 ++ ...payload-silc_ske_payload_start_decode.html | 224 ++ ...payload-silc_ske_payload_start_encode.html | 223 ++ ...e_payload-silc_ske_payload_start_free.html | 219 ++ docs/toolkit/manual/silcske_payload.html | 224 ++ docs/toolkit/manual/silcske_payload.xref | 15 + docs/toolkit/manual/silcskelib.html | 217 ++ docs/toolkit/manual/silcskr-SilcSKR.html | 242 ++ docs/toolkit/manual/silcskr-SilcSKRFind.html | 242 ++ .../manual/silcskr-SilcSKRFindCallback.html | 247 ++ docs/toolkit/manual/silcskr-SilcSKRKey.html | 249 ++ .../manual/silcskr-SilcSKRKeyUsage.html | 258 ++ .../toolkit/manual/silcskr-SilcSKRStatus.html | 259 ++ .../silcskr-silc_skr_add_public_key.html | 266 ++ ...ilcskr-silc_skr_add_public_key_simple.html | 257 ++ .../manual/silcskr-silc_skr_alloc.html | 239 ++ .../silcskr-silc_skr_del_public_key.html | 245 ++ .../toolkit/manual/silcskr-silc_skr_find.html | 261 ++ .../silcskr-silc_skr_find_add_pkcs_type.html | 241 ++ .../manual/silcskr-silc_skr_find_alloc.html | 241 ++ .../manual/silcskr-silc_skr_find_free.html | 239 ++ .../silcskr-silc_skr_find_set_context.html | 241 ++ .../silcskr-silc_skr_find_set_country.html | 243 ++ .../silcskr-silc_skr_find_set_email.html | 243 ++ .../silcskr-silc_skr_find_set_host.html | 243 ++ .../manual/silcskr-silc_skr_find_set_org.html | 243 ++ .../silcskr-silc_skr_find_set_public_key.html | 241 ++ .../silcskr-silc_skr_find_set_realname.html | 243 ++ .../silcskr-silc_skr_find_set_usage.html | 243 ++ .../silcskr-silc_skr_find_set_username.html | 243 ++ .../toolkit/manual/silcskr-silc_skr_free.html | 239 ++ .../toolkit/manual/silcskr-silc_skr_init.html | 241 ++ .../silcskr-silc_skr_ref_public_key.html | 241 ++ .../manual/silcskr-silc_skr_uninit.html | 240 ++ .../silcskr-silc_skr_unref_public_key.html | 241 ++ docs/toolkit/manual/silcskr.html | 245 ++ docs/toolkit/manual/silcskr.xref | 35 + docs/toolkit/manual/silcskr_i.html | 203 ++ docs/toolkit/manual/silcskr_i.xref | 6 + docs/toolkit/manual/silcskrlib.html | 215 ++ .../manual/silcsnprintf-silc_asprintf.html | 216 ++ .../manual/silcsnprintf-silc_snprintf.html | 218 ++ .../manual/silcsnprintf-silc_vasprintf.html | 216 ++ .../manual/silcsnprintf-silc_vsnprintf.html | 217 ++ docs/toolkit/manual/silcsnprintf.html | 217 ++ docs/toolkit/manual/silcsnprintf.xref | 11 + ...socketstream-SilcSocketStreamCallback.html | 233 ++ ...lcsocketstream-SilcSocketStreamStatus.html | 231 ++ ...etstream-silc_socket_stream_get_error.html | 221 ++ ...ketstream-silc_socket_stream_get_info.html | 225 ++ ...ocketstream-silc_socket_stream_is_udp.html | 226 ++ ...ketstream-silc_socket_stream_set_info.html | 230 ++ ...cketstream-silc_socket_stream_set_qos.html | 233 ++ ...tstream-silc_socket_tcp_stream_create.html | 243 ++ ...tstream-silc_socket_udp_stream_create.html | 245 ++ docs/toolkit/manual/silcsocketstream.html | 228 ++ docs/toolkit/manual/silcsocketstream.xref | 16 + docs/toolkit/manual/silcsocketstream_i.html | 203 ++ docs/toolkit/manual/silcsocketstream_i.xref | 6 + docs/toolkit/manual/silcstack-SilcStack.html | 220 ++ .../manual/silcstack-SilcStackFrame.html | 225 ++ .../manual/silcstack-silc_stack_alloc.html | 222 ++ .../manual/silcstack-silc_stack_free.html | 218 ++ .../manual/silcstack-silc_stack_pop.html | 242 ++ .../manual/silcstack-silc_stack_push.html | 269 ++ docs/toolkit/manual/silcstack.html | 245 ++ docs/toolkit/manual/silcstack.xref | 13 + docs/toolkit/manual/silcstack_i.html | 203 ++ docs/toolkit/manual/silcstack_i.xref | 6 + .../toolkit/manual/silcstatus-SilcStatus.html | 275 ++ .../silcstatus-silc_status_get_args.html | 217 ++ docs/toolkit/manual/silcstatus.html | 219 ++ docs/toolkit/manual/silcstatus.xref | 9 + docs/toolkit/manual/silcstatus_args.html | 685 +++++ .../toolkit/manual/silcstream-SilcStream.html | 224 ++ .../manual/silcstream-SilcStreamNotifier.html | 226 ++ .../manual/silcstream-SilcStreamOps.html | 273 ++ .../manual/silcstream-SilcStreamStatus.html | 234 ++ .../manual/silcstream-silc_stream_close.html | 224 ++ .../silcstream-silc_stream_destroy.html | 225 ++ .../silcstream-silc_stream_get_schedule.html | 222 ++ .../manual/silcstream-silc_stream_read.html | 227 ++ .../silcstream-silc_stream_set_notifier.html | 236 ++ .../manual/silcstream-silc_stream_write.html | 227 ++ docs/toolkit/manual/silcstream.html | 229 ++ docs/toolkit/manual/silcstream.xref | 17 + .../silcstringprep-SilcStringprepFlags.html | 221 ++ .../silcstringprep-SilcStringprepStatus.html | 230 ++ .../silcstringprep-silc_stringprep.html | 245 ++ docs/toolkit/manual/silcstringprep.html | 219 ++ docs/toolkit/manual/silcstringprep.xref | 10 + .../silcstrutil-SilcStringEncoding.html | 246 ++ .../silcstrutil-silc_base64_encode.html | 222 ++ .../silcstrutil-silc_base64_encode_file.html | 222 ++ .../manual/silcstrutil-silc_base_decode.html | 223 ++ .../silcstrutil-silc_string_compare.html | 222 ++ .../manual/silcstrutil-silc_string_match.html | 222 ++ .../silcstrutil-silc_string_regex_match.html | 221 ++ .../silcstrutil-silc_string_regexify.html | 223 ++ .../manual/silcstrutil-silc_string_split.html | 225 ++ .../manual/silcstrutil-silc_strncat.html | 224 ++ docs/toolkit/manual/silcstrutil.html | 224 ++ docs/toolkit/manual/silcstrutil.xref | 17 + .../manual/silcsymbiansocketstream.html | 203 ++ .../manual/silcsymbiansocketstream.xref | 6 + .../toolkit/manual/silcthread-SilcThread.html | 221 ++ .../manual/silcthread-SilcThreadStart.html | 223 ++ .../manual/silcthread-silc_thread_create.html | 239 ++ .../manual/silcthread-silc_thread_exit.html | 222 ++ .../manual/silcthread-silc_thread_self.html | 218 ++ .../manual/silcthread-silc_thread_wait.html | 223 ++ .../manual/silcthread-silc_thread_yield.html | 219 ++ docs/toolkit/manual/silcthread.html | 222 ++ docs/toolkit/manual/silcthread.xref | 14 + docs/toolkit/manual/silctime-SilcTime.html | 229 ++ .../manual/silctime-silc_compare_timeval.html | 227 ++ .../manual/silctime-silc_gettimeofday.html | 226 ++ docs/toolkit/manual/silctime-silc_time.html | 226 ++ .../silctime-silc_time_generalized.html | 244 ++ ...silctime-silc_time_generalized_string.html | 228 ++ .../manual/silctime-silc_time_msec.html | 226 ++ .../manual/silctime-silc_time_string.html | 229 ++ .../manual/silctime-silc_time_universal.html | 240 ++ .../silctime-silc_time_universal_string.html | 227 ++ .../manual/silctime-silc_time_usec.html | 226 ++ .../manual/silctime-silc_time_value.html | 228 ++ .../manual/silctime-silc_timezone.html | 231 ++ docs/toolkit/manual/silctime-silc_usleep.html | 233 ++ docs/toolkit/manual/silctime.html | 228 ++ docs/toolkit/manual/silctime.xref | 21 + docs/toolkit/manual/silctypes-FALSE.html | 244 ++ .../manual/silctypes-SILC_32_TO_PTR.html | 248 ++ .../manual/silctypes-SILC_64_TO_PTR.html | 249 ++ .../manual/silctypes-SILC_GET16_LSB.html | 250 ++ .../manual/silctypes-SILC_GET16_MSB.html | 246 ++ .../manual/silctypes-SILC_GET32_LSB.html | 263 ++ .../manual/silctypes-SILC_GET32_MSB.html | 248 ++ .../manual/silctypes-SILC_GET64_MSB.html | 246 ++ .../manual/silctypes-SILC_PTR_TO_32.html | 249 ++ .../manual/silctypes-SILC_PTR_TO_64.html | 248 ++ .../manual/silctypes-SILC_PUT16_LSB.html | 250 ++ .../manual/silctypes-SILC_PUT16_MSB.html | 246 ++ .../manual/silctypes-SILC_PUT32_LSB.html | 252 ++ .../manual/silctypes-SILC_PUT32_MSB.html | 248 ++ .../manual/silctypes-SILC_PUT64_MSB.html | 246 ++ .../manual/silctypes-SILC_SWAB_16.html | 244 ++ .../manual/silctypes-SILC_SWAB_32.html | 246 ++ docs/toolkit/manual/silctypes-SilcBool.html | 239 ++ docs/toolkit/manual/silctypes-SilcInt16.html | 242 ++ docs/toolkit/manual/silctypes-SilcInt32.html | 239 ++ docs/toolkit/manual/silctypes-SilcInt64.html | 240 ++ docs/toolkit/manual/silctypes-SilcInt8.html | 242 ++ docs/toolkit/manual/silctypes-SilcSocket.html | 251 ++ docs/toolkit/manual/silctypes-SilcUInt16.html | 242 ++ docs/toolkit/manual/silctypes-SilcUInt32.html | 257 ++ docs/toolkit/manual/silctypes-SilcUInt64.html | 259 ++ docs/toolkit/manual/silctypes-SilcUInt8.html | 242 ++ docs/toolkit/manual/silctypes-TRUE.html | 244 ++ docs/toolkit/manual/silctypes.html | 243 ++ docs/toolkit/manual/silctypes.xref | 35 + .../manual/silcutf8-silc_utf8_c2w.html | 230 ++ .../manual/silcutf8-silc_utf8_decode.html | 228 ++ .../silcutf8-silc_utf8_decoded_len.html | 224 ++ .../manual/silcutf8-silc_utf8_encode.html | 226 ++ .../silcutf8-silc_utf8_encoded_len.html | 224 ++ .../manual/silcutf8-silc_utf8_strcasecmp.html | 226 ++ .../silcutf8-silc_utf8_strncasecmp.html | 227 ++ .../manual/silcutf8-silc_utf8_valid.html | 221 ++ .../manual/silcutf8-silc_utf8_w2c.html | 227 ++ docs/toolkit/manual/silcutf8.html | 223 ++ docs/toolkit/manual/silcutf8.xref | 16 + .../manual/silcutil-silc_check_line.html | 241 ++ .../manual/silcutil-silc_fingerprint.html | 240 ++ docs/toolkit/manual/silcutil-silc_format.html | 240 ++ .../manual/silcutil-silc_get_input.html | 239 ++ .../manual/silcutil-silc_get_real_name.html | 242 ++ .../manual/silcutil-silc_get_username.html | 243 ++ docs/toolkit/manual/silcutil-silc_gets.html | 242 ++ .../silcutil-silc_hash_client_id_compare.html | 240 ++ .../silcutil-silc_hash_client_id_hash.html | 239 ++ .../manual/silcutil-silc_hash_data.html | 239 ++ .../silcutil-silc_hash_data_compare.html | 240 ++ .../toolkit/manual/silcutil-silc_hash_id.html | 239 ++ .../manual/silcutil-silc_hash_id_compare.html | 242 ++ .../silcutil-silc_hash_id_compare_full.html | 242 ++ .../manual/silcutil-silc_hash_ptr.html | 239 ++ .../manual/silcutil-silc_hash_public_key.html | 239 ++ ...silcutil-silc_hash_public_key_compare.html | 241 ++ .../manual/silcutil-silc_hash_string.html | 242 ++ .../silcutil-silc_hash_string_compare.html | 241 ++ .../manual/silcutil-silc_hash_uint.html | 239 ++ .../silcutil-silc_hash_utf8_compare.html | 241 ++ .../silcutil-silc_hash_utf8_string.html | 241 ++ .../silcutil-silc_parse_command_line.html | 247 ++ .../manual/silcutil-silc_parse_userfqdn.html | 243 ++ .../manual/silcutil-silc_string_is_ascii.html | 240 ++ .../manual/silcutil-silc_to_lower.html | 240 ++ .../manual/silcutil-silc_to_upper.html | 240 ++ .../toolkit/manual/silcutil-silc_va_copy.html | 242 ++ docs/toolkit/manual/silcutil.html | 240 ++ docs/toolkit/manual/silcutil.xref | 35 + docs/toolkit/manual/silcutillib.html | 275 ++ docs/toolkit/manual/silcvcard-SilcVCard.html | 274 ++ .../manual/silcvcard-silc_vcard_alloc.html | 218 ++ .../manual/silcvcard-silc_vcard_decode.html | 222 ++ .../manual/silcvcard-silc_vcard_encode.html | 221 ++ .../manual/silcvcard-silc_vcard_fprintf.html | 218 ++ .../manual/silcvcard-silc_vcard_free.html | 217 ++ docs/toolkit/manual/silcvcard.html | 222 ++ docs/toolkit/manual/silcvcard.xref | 13 + docs/toolkit/manual/silcvcardlib.html | 216 ++ docs/toolkit/manual/space.gif | Bin 0 -> 43 bytes docs/toolkit/manual/toolkit_index.html | 2670 +++++++++++++++++ docs/toolkit/manual/zlib.html | 1165 +++++++ 1455 files changed, 341702 insertions(+) create mode 100644 docs/client/ChangeLog create mode 100644 docs/client/ReleaseNotes create mode 100644 docs/server/ChangeLog create mode 100644 docs/silcd.conf.5 create mode 100644 docs/silcd.pub create mode 100644 docs/silcnet_silcd.conf create mode 100644 docs/toolkit/ChangeLog create mode 100644 docs/toolkit/manual/arch.gif create mode 100644 docs/toolkit/manual/box.gif create mode 100644 docs/toolkit/manual/box2.gif create mode 100644 docs/toolkit/manual/building.html create mode 100644 docs/toolkit/manual/command_reply_args.html create mode 100644 docs/toolkit/manual/dot.gif create mode 100644 docs/toolkit/manual/index.html create mode 100644 docs/toolkit/manual/index.tmpl create mode 100644 docs/toolkit/manual/index_pic.gif create mode 100644 docs/toolkit/manual/intro_reference.html create mode 100644 docs/toolkit/manual/notifyargs.html create mode 100644 docs/toolkit/manual/platforms.html create mode 100644 docs/toolkit/manual/porting.html create mode 100644 docs/toolkit/manual/programming_conv.html create mode 100644 docs/toolkit/manual/silcapputil-silc_change_private_key_passphrase.html create mode 100644 docs/toolkit/manual/silcapputil-silc_channel_name_check.html create mode 100644 docs/toolkit/manual/silcapputil-silc_channel_name_verify.html create mode 100644 docs/toolkit/manual/silcapputil-silc_client_chmode.html create mode 100644 docs/toolkit/manual/silcapputil-silc_client_chumode.html create mode 100644 docs/toolkit/manual/silcapputil-silc_client_chumode_char.html create mode 100644 docs/toolkit/manual/silcapputil-silc_create_key_pair.html create mode 100644 docs/toolkit/manual/silcapputil-silc_get_command_name.html create mode 100644 docs/toolkit/manual/silcapputil-silc_get_mode_list.html create mode 100644 docs/toolkit/manual/silcapputil-silc_get_packet_name.html create mode 100644 docs/toolkit/manual/silcapputil-silc_get_status_message.html create mode 100644 docs/toolkit/manual/silcapputil-silc_id_render.html create mode 100644 docs/toolkit/manual/silcapputil-silc_identifier_check.html create mode 100644 docs/toolkit/manual/silcapputil-silc_identifier_verify.html create mode 100644 docs/toolkit/manual/silcapputil-silc_load_key_pair.html create mode 100644 docs/toolkit/manual/silcapputil-silc_parse_version_string.html create mode 100644 docs/toolkit/manual/silcapputil-silc_show_public_key.html create mode 100644 docs/toolkit/manual/silcapputil-silc_show_public_key_file.html create mode 100644 docs/toolkit/manual/silcapputil-silc_version_to_num.html create mode 100644 docs/toolkit/manual/silcapputil.html create mode 100644 docs/toolkit/manual/silcapputil.xref create mode 100644 docs/toolkit/manual/silcaputillib.html create mode 100644 docs/toolkit/manual/silcargument-SilcArgumentDecodeType.html create mode 100644 docs/toolkit/manual/silcargument-SilcArgumentDecodedList.html create mode 100644 docs/toolkit/manual/silcargument-SilcArgumentPayload.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_get_arg_num.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_get_arg_type.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_get_decoded.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_get_first_arg.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_get_next_arg.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_list_free.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_list_parse.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_list_parse_decoded.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_payload_encode.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_payload_encode_one.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_payload_encode_payload.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_payload_free.html create mode 100644 docs/toolkit/manual/silcargument-silc_argument_payload_parse.html create mode 100644 docs/toolkit/manual/silcargument.html create mode 100644 docs/toolkit/manual/silcargument.xref create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_ANY.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_ANY_PRIMITIVE.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_BIT_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_BMP_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_BOOLEAN.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_CHOICE.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_END.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_ENUM.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_GENERAL_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_GEN_TIME.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_IA5_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_INT.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_NULL.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_NUMERIC_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_OCTET_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_OID.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_OPTS.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_PRINTABLE_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE_OF.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_SET.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_SET_OF.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_SHORT_INT.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_TELETEX_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_UNIVERSAL_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_UNRESTRICTED_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_UTC_TIME.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_UTF8_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SILC_ASN1_VISIBLE_STRING.html create mode 100644 docs/toolkit/manual/silcasn1-SilcAsn1.html create mode 100644 docs/toolkit/manual/silcasn1-SilcAsn1Options.html create mode 100644 docs/toolkit/manual/silcasn1-SilcAsn1Struct.html create mode 100644 docs/toolkit/manual/silcasn1-SilcAsn1Tag.html create mode 100644 docs/toolkit/manual/silcasn1-silc_asn1_alloc.html create mode 100644 docs/toolkit/manual/silcasn1-silc_asn1_decode.html create mode 100644 docs/toolkit/manual/silcasn1-silc_asn1_encode.html create mode 100644 docs/toolkit/manual/silcasn1-silc_asn1_free.html create mode 100644 docs/toolkit/manual/silcasn1-silc_asn1_init.html create mode 100644 docs/toolkit/manual/silcasn1-silc_asn1_uninit.html create mode 100644 docs/toolkit/manual/silcasn1.html create mode 100644 docs/toolkit/manual/silcasn1.xref create mode 100644 docs/toolkit/manual/silcasn1_i.html create mode 100644 docs/toolkit/manual/silcasn1_i.xref create mode 100644 docs/toolkit/manual/silcasn1lib.html create mode 100644 docs/toolkit/manual/silcasync-SilcAsyncOperation.html create mode 100644 docs/toolkit/manual/silcasync-SilcAsyncOperationAbort.html create mode 100644 docs/toolkit/manual/silcasync-SilcAsyncOperationPause.html create mode 100644 docs/toolkit/manual/silcasync-SilcAsyncOperationStruct.html create mode 100644 docs/toolkit/manual/silcasync-silc_async_abort.html create mode 100644 docs/toolkit/manual/silcasync-silc_async_alloc.html create mode 100644 docs/toolkit/manual/silcasync-silc_async_free.html create mode 100644 docs/toolkit/manual/silcasync-silc_async_get_context.html create mode 100644 docs/toolkit/manual/silcasync-silc_async_halt.html create mode 100644 docs/toolkit/manual/silcasync-silc_async_init.html create mode 100644 docs/toolkit/manual/silcasync-silc_async_resume.html create mode 100644 docs/toolkit/manual/silcasync.html create mode 100644 docs/toolkit/manual/silcasync.xref create mode 100644 docs/toolkit/manual/silcasync_i.html create mode 100644 docs/toolkit/manual/silcasync_i.xref create mode 100644 docs/toolkit/manual/silcatomic-SilcAtomic16.html create mode 100644 docs/toolkit/manual/silcatomic-SilcAtomic32.html create mode 100644 docs/toolkit/manual/silcatomic-SilcAtomic8.html create mode 100644 docs/toolkit/manual/silcatomic-SilcAtomicPointer.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_add_int16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_add_int32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_add_int8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_cas16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_cas32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_cas8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_cas_pointer.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_dec16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_dec32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_dec8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_get_int16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_get_int32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_get_int8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_get_pointer.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_inc16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_inc32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_inc8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_init16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_init32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_init8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_init_pointer.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_set_int16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_set_int32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_set_int8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_set_pointer.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_sub_int16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_sub_int32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_sub_int8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_uninit16.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_uninit32.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_uninit8.html create mode 100644 docs/toolkit/manual/silcatomic-silc_atomic_uninit_pointer.html create mode 100644 docs/toolkit/manual/silcatomic.html create mode 100644 docs/toolkit/manual/silcatomic.xref create mode 100644 docs/toolkit/manual/silcattrs-SilcAttribute.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeContact.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeDevice.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeFlags.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeMood.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeObjDevice.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeObjGeo.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeObjPN.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeObjPk.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributeObjService.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributePNFormat.html create mode 100644 docs/toolkit/manual/silcattrs-SilcAttributePayload.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_get_attribute.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_get_data.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_get_flags.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_get_object.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_get_verify_data.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_payload_alloc.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_payload_encode.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_payload_encode_data.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_payload_free.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_payload_list_free.html create mode 100644 docs/toolkit/manual/silcattrs-silc_attribute_payload_parse.html create mode 100644 docs/toolkit/manual/silcattrs.html create mode 100644 docs/toolkit/manual/silcattrs.xref create mode 100644 docs/toolkit/manual/silcauth-SilcAuthMethod.html create mode 100644 docs/toolkit/manual/silcauth-SilcAuthPayload.html create mode 100644 docs/toolkit/manual/silcauth-SilcKeyAgreementPayload.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_get_data.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_get_method.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_get_public_data.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_payload_encode.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_payload_free.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_payload_parse.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate_wpub.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify_data.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_verify.html create mode 100644 docs/toolkit/manual/silcauth-silc_auth_verify_data.html create mode 100644 docs/toolkit/manual/silcauth-silc_key_agreement_get_hostname.html create mode 100644 docs/toolkit/manual/silcauth-silc_key_agreement_get_port.html create mode 100644 docs/toolkit/manual/silcauth-silc_key_agreement_get_protocol.html create mode 100644 docs/toolkit/manual/silcauth-silc_key_agreement_payload_encode.html create mode 100644 docs/toolkit/manual/silcauth-silc_key_agreement_payload_free.html create mode 100644 docs/toolkit/manual/silcauth-silc_key_agreement_payload_parse.html create mode 100644 docs/toolkit/manual/silcauth.html create mode 100644 docs/toolkit/manual/silcauth.xref create mode 100644 docs/toolkit/manual/silcber-SilcBerClass.html create mode 100644 docs/toolkit/manual/silcber-SilcBerEncoding.html create mode 100644 docs/toolkit/manual/silcber-silc_ber_decode.html create mode 100644 docs/toolkit/manual/silcber-silc_ber_encode.html create mode 100644 docs/toolkit/manual/silcber-silc_ber_encoded_len.html create mode 100644 docs/toolkit/manual/silcber.html create mode 100644 docs/toolkit/manual/silcber.xref create mode 100644 docs/toolkit/manual/silcbuffer-SilcBuffer.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_alloc.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_alloc_size.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_clear.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_clone.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_copy.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_data.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_datalen.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_end.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_enlarge.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_free.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_headlen.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_len.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_pull.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_pull_tail.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_purge.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_push.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_push_tail.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_put.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_put_head.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_put_tail.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_realloc.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_realloc_size.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_reset.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_salloc.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_salloc_size.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_sclone.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_scopy.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_senlarge.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_set.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_srealloc.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_srealloc_size.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_start.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_steal.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_taillen.html create mode 100644 docs/toolkit/manual/silcbuffer-silc_buffer_truelen.html create mode 100644 docs/toolkit/manual/silcbuffer.html create mode 100644 docs/toolkit/manual/silcbuffer.xref create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STRFMT_END.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_*_CHAR.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT64.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_*_NSTRING.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_*_SHORT.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_*_STRING.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_ADVANCE.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_BUFFER.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_DATA.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_END.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_FUNC.html create mode 100644 docs/toolkit/manual/silcbuffmt-SILC_STR_OFFSET.html create mode 100644 docs/toolkit/manual/silcbuffmt-SilcBufferFormatFunc.html create mode 100644 docs/toolkit/manual/silcbuffmt-SilcBufferParamType.html create mode 100644 docs/toolkit/manual/silcbuffmt-SilcBufferSFormatFunc.html create mode 100644 docs/toolkit/manual/silcbuffmt-SilcBufferSUnformatFunc.html create mode 100644 docs/toolkit/manual/silcbuffmt-SilcBufferUnformatFunc.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_format.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_format_vp.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_sformat.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_sformat_vp.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_sstrformat.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_strformat.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat_vp.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_unformat.html create mode 100644 docs/toolkit/manual/silcbuffmt-silc_buffer_unformat_vp.html create mode 100644 docs/toolkit/manual/silcbuffmt.html create mode 100644 docs/toolkit/manual/silcbuffmt.xref create mode 100644 docs/toolkit/manual/silcchannel-SilcChannelKeyPayload.html create mode 100644 docs/toolkit/manual/silcchannel-SilcChannelPayload.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_get_id.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_get_id_parse.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_get_mode.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_get_name.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_key_get_cipher.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_key_get_id.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_key_get_key.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_key_payload_encode.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_key_payload_free.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_key_payload_parse.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_payload_encode.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_payload_free.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_payload_list_free.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_payload_parse.html create mode 100644 docs/toolkit/manual/silcchannel-silc_channel_payload_parse_list.html create mode 100644 docs/toolkit/manual/silcchannel.html create mode 100644 docs/toolkit/manual/silcchannel.xref create mode 100644 docs/toolkit/manual/silccipher-SilcCipher.html create mode 100644 docs/toolkit/manual/silccipher-SilcCipherMode.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_alloc.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_decrypt.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_encrypt.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_free.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_get_block_len.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_get_iv.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_get_iv_len.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_get_key_len.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_get_mode.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_get_name.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_get_supported.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_is_supported.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_register.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_register_default.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_set_iv.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_set_key.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_unregister.html create mode 100644 docs/toolkit/manual/silccipher-silc_cipher_unregister_all.html create mode 100644 docs/toolkit/manual/silccipher.html create mode 100644 docs/toolkit/manual/silccipher.xref create mode 100644 docs/toolkit/manual/silcclient-SilcAskPassphrase.html create mode 100644 docs/toolkit/manual/silcclient-SilcChannelPrivateKey.html create mode 100644 docs/toolkit/manual/silcclient-SilcChannelUser.html create mode 100644 docs/toolkit/manual/silcclient-SilcClient.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientCommandReply.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientConnectCallback.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientConnection.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientConnectionParams.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientConnectionStatus.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientFileAskName.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientFileError.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientFileMonitor.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientFileName.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientMessageType.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientMonitorStatus.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientOperations.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientParams.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientRunning.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientStats.html create mode 100644 docs/toolkit/manual/silcclient-SilcClientStopped.html create mode 100644 docs/toolkit/manual/silcclient-SilcGetAuthMeth.html create mode 100644 docs/toolkit/manual/silcclient-SilcKeyAgreementCallback.html create mode 100644 docs/toolkit/manual/silcclient-SilcKeyAgreementStatus.html create mode 100644 docs/toolkit/manual/silcclient-SilcPrivateMessageKeys.html create mode 100644 docs/toolkit/manual/silcclient-SilcVerifyPublicKey.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_abort_key_agreement.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_add_channel_private_key.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_add_private_message_key.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_add_private_message_key_ske.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_alloc.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_attribute_add.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_attribute_del.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_attributes_get.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_attributes_request.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_close_connection.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_command_call.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_command_pending.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_command_send.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_connect_to_client.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_connect_to_server.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_current_channel_private_key.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_del_channel_private_key.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_del_channel_private_keys.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_del_private_message_key.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_file_close.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_file_receive.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_file_send.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_free.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_free_private_message_keys.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_init.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_key_exchange.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_list_channel_private_keys.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_list_private_message_keys.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_nickname_format.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_nickname_parse.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_on_channel.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_perform_key_agreement.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_perform_key_agreement_stream.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_private_message_key_is_set.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_private_message_wait.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_private_message_wait_init.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_private_message_wait_uninit.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_run.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_run_one.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_send_channel_message.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_send_key_agreement.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_send_private_message.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_set_away_message.html create mode 100644 docs/toolkit/manual/silcclient-silc_client_stop.html create mode 100644 docs/toolkit/manual/silcclient.html create mode 100644 docs/toolkit/manual/silcclient.xref create mode 100644 docs/toolkit/manual/silcclient_entry-SilcChannelEntry.html create mode 100644 docs/toolkit/manual/silcclient_entry-SilcClientEntry.html create mode 100644 docs/toolkit/manual/silcclient_entry-SilcGetChannelCallback.html create mode 100644 docs/toolkit/manual/silcclient_entry-SilcGetClientCallback.html create mode 100644 docs/toolkit/manual/silcclient_entry-SilcGetServerCallback.html create mode 100644 docs/toolkit/manual/silcclient_entry-SilcServerEntry.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_channel.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id_resolve.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_channel_resolve.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id_resolve.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_clients.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_clients_local.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_clients_whois.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_server.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id_resolve.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_list_free.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_list_free_channel.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_list_free_server.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_lock_channel.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_lock_client.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_lock_server.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_ref_channel.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_ref_client.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_ref_server.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_unlock_channel.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_unlock_client.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_unlock_server.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_unref_channel.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_unref_client.html create mode 100644 docs/toolkit/manual/silcclient_entry-silc_client_unref_server.html create mode 100644 docs/toolkit/manual/silcclient_entry.html create mode 100644 docs/toolkit/manual/silcclient_entry.xref create mode 100644 docs/toolkit/manual/silcclient_unicode.html create mode 100644 docs/toolkit/manual/silcclient_using.html create mode 100644 docs/toolkit/manual/silcclientlib.html create mode 100644 docs/toolkit/manual/silccommand-SilcCommand.html create mode 100644 docs/toolkit/manual/silccommand-SilcCommandCb.html create mode 100644 docs/toolkit/manual/silccommand-SilcCommandFlags.html create mode 100644 docs/toolkit/manual/silccommand-SilcCommandPayload.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_free.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_get.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_get_args.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_get_ident.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_get_status.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_payload_encode.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_payload_encode_payload.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_payload_encode_va.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_payload_encode_vap.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_payload_parse.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_va.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_vap.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_set_command.html create mode 100644 docs/toolkit/manual/silccommand-silc_command_set_ident.html create mode 100644 docs/toolkit/manual/silccommand.html create mode 100644 docs/toolkit/manual/silccommand.xref create mode 100644 docs/toolkit/manual/silccond-SilcCond.html create mode 100644 docs/toolkit/manual/silccond-silc_cond_alloc.html create mode 100644 docs/toolkit/manual/silccond-silc_cond_broadcast.html create mode 100644 docs/toolkit/manual/silccond-silc_cond_free.html create mode 100644 docs/toolkit/manual/silccond-silc_cond_signal.html create mode 100644 docs/toolkit/manual/silccond-silc_cond_timedwait.html create mode 100644 docs/toolkit/manual/silccond-silc_cond_wait.html create mode 100644 docs/toolkit/manual/silccond.html create mode 100644 docs/toolkit/manual/silccond.xref create mode 100644 docs/toolkit/manual/silcconfig-SILC_CONFIG_CALLBACK.html create mode 100644 docs/toolkit/manual/silcconfig-SilcConfigCallback.html create mode 100644 docs/toolkit/manual/silcconfig-SilcConfigEntity.html create mode 100644 docs/toolkit/manual/silcconfig-SilcConfigErrno.html create mode 100644 docs/toolkit/manual/silcconfig-SilcConfigFile.html create mode 100644 docs/toolkit/manual/silcconfig-SilcConfigTable.html create mode 100644 docs/toolkit/manual/silcconfig-SilcConfigType.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_close.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_get_filename.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_get_line.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_init.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_main.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_open.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_read_current_line.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_read_line.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_register.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_register_table.html create mode 100644 docs/toolkit/manual/silcconfig-silc_config_strerror.html create mode 100644 docs/toolkit/manual/silcconfig.html create mode 100644 docs/toolkit/manual/silcconfig.xref create mode 100644 docs/toolkit/manual/silcconnauth-SilcConnAuth.html create mode 100644 docs/toolkit/manual/silcconnauth-SilcConnAuthCompletion.html create mode 100644 docs/toolkit/manual/silcconnauth-SilcConnAuthGetAuthData.html create mode 100644 docs/toolkit/manual/silcconnauth-SilcConnectionType.html create mode 100644 docs/toolkit/manual/silcconnauth-silc_connauth_alloc.html create mode 100644 docs/toolkit/manual/silcconnauth-silc_connauth_free.html create mode 100644 docs/toolkit/manual/silcconnauth-silc_connauth_get_ske.html create mode 100644 docs/toolkit/manual/silcconnauth-silc_connauth_initiator.html create mode 100644 docs/toolkit/manual/silcconnauth-silc_connauth_responder.html create mode 100644 docs/toolkit/manual/silcconnauth.html create mode 100644 docs/toolkit/manual/silcconnauth.xref create mode 100644 docs/toolkit/manual/silccorelib.html create mode 100644 docs/toolkit/manual/silccryptlib.html create mode 100644 docs/toolkit/manual/silcdh-SilcDH.html create mode 100644 docs/toolkit/manual/silcdh-silc_dh_alloc.html create mode 100644 docs/toolkit/manual/silcdh-silc_dh_compute_key.html create mode 100644 docs/toolkit/manual/silcdh-silc_dh_compute_public.html create mode 100644 docs/toolkit/manual/silcdh-silc_dh_free.html create mode 100644 docs/toolkit/manual/silcdh-silc_dh_generate_private.html create mode 100644 docs/toolkit/manual/silcdh-silc_dh_remote_public(1).html create mode 100644 docs/toolkit/manual/silcdh-silc_dh_remote_public.html create mode 100644 docs/toolkit/manual/silcdh.html create mode 100644 docs/toolkit/manual/silcdh.xref create mode 100644 docs/toolkit/manual/silcdlist-SilcDList.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_add.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_count.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_del.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_end.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_get.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_init.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_insert.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_start.html create mode 100644 docs/toolkit/manual/silcdlist-silc_dlist_uninit.html create mode 100644 docs/toolkit/manual/silcdlist.html create mode 100644 docs/toolkit/manual/silcdlist.xref create mode 100644 docs/toolkit/manual/silcdoc_xref create mode 100644 docs/toolkit/manual/silcexample-SilcExampleStruct.html create mode 100644 docs/toolkit/manual/silcexample-SilcExampleType.html create mode 100644 docs/toolkit/manual/silcexample-silc_example_function.html create mode 100644 docs/toolkit/manual/silcexample.html create mode 100644 docs/toolkit/manual/silcexample.xref create mode 100644 docs/toolkit/manual/silcfdstream-silc_fd_stream_create.html create mode 100644 docs/toolkit/manual/silcfdstream-silc_fd_stream_create2.html create mode 100644 docs/toolkit/manual/silcfdstream-silc_fd_stream_file.html create mode 100644 docs/toolkit/manual/silcfdstream-silc_fd_stream_file2.html create mode 100644 docs/toolkit/manual/silcfdstream-silc_fd_stream_get_error.html create mode 100644 docs/toolkit/manual/silcfdstream-silc_fd_stream_get_info.html create mode 100644 docs/toolkit/manual/silcfdstream.html create mode 100644 docs/toolkit/manual/silcfdstream.xref create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_close.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_open.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_open_mode.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_read.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_readfile.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_set_nonblock.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_size.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_write.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_writefile.html create mode 100644 docs/toolkit/manual/silcfileutil-silc_file_writefile_mode.html create mode 100644 docs/toolkit/manual/silcfileutil.html create mode 100644 docs/toolkit/manual/silcfileutil.xref create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_CALL.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE_SYNC.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_CONTINUE.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_SIGNAL.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_TIMEDWAIT.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_WAIT.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_FINISH.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_STATE.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_THREAD_WAIT.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_WAIT.html create mode 100644 docs/toolkit/manual/silcfsm-SILC_FSM_YIELD.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSM.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSMDestructor.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSMEvent.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSMEventStruct.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSMStruct.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSMThread.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSMThreadDestructor.html create mode 100644 docs/toolkit/manual/silcfsm-SilcFSMThreadStruct.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_alloc.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_continue.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_continue_sync.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_event_alloc.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_event_free.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_event_init.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_finish.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_free.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_get_context.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_get_machine.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_get_schedule.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_get_state_context.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_init.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_is_started.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_next.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_next_later.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_set_context.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_set_state_context.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_start.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_start_sync.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_thread_alloc.html create mode 100644 docs/toolkit/manual/silcfsm-silc_fsm_thread_init.html create mode 100644 docs/toolkit/manual/silcfsm.html create mode 100644 docs/toolkit/manual/silcfsm.xref create mode 100644 docs/toolkit/manual/silcfsm_i.html create mode 100644 docs/toolkit/manual/silcfsm_i.xref create mode 100644 docs/toolkit/manual/silchash-SilcHash.html create mode 100644 docs/toolkit/manual/silchash-SilcHashObject.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_alloc.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_alloc_by_oid.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_babbleprint.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_block_len.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_final.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_fingerprint.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_free.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_get_name.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_get_oid.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_get_supported.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_init.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_is_supported.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_len.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_make.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_register.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_register_default.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_transform.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_unregister.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_unregister_all.html create mode 100644 docs/toolkit/manual/silchash-silc_hash_update.html create mode 100644 docs/toolkit/manual/silchash.html create mode 100644 docs/toolkit/manual/silchash.xref create mode 100644 docs/toolkit/manual/silchashtable-SilcHashCompare.html create mode 100644 docs/toolkit/manual/silchashtable-SilcHashDestructor.html create mode 100644 docs/toolkit/manual/silchashtable-SilcHashForeach.html create mode 100644 docs/toolkit/manual/silchashtable-SilcHashFunction.html create mode 100644 docs/toolkit/manual/silchashtable-SilcHashTable.html create mode 100644 docs/toolkit/manual/silchashtable-SilcHashTableList.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_add.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_add_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_alloc.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_count.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_del.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_del_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_find.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_find_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_foreach.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_free.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_get.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_list.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_list_reset.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_rehash.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_rehash_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_replace.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_replace_ext.html create mode 100644 docs/toolkit/manual/silchashtable-silc_hash_table_size.html create mode 100644 docs/toolkit/manual/silchashtable.html create mode 100644 docs/toolkit/manual/silchashtable.xref create mode 100644 docs/toolkit/manual/silchmac-SilcHmac.html create mode 100644 docs/toolkit/manual/silchmac-SilcHmacObject.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_alloc.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_final.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_free.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_get_hash.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_get_key.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_get_name.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_get_supported.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_init.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_init_with_key.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_is_supported.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_len.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_make.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_make_truncated.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_make_with_key.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_register.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_register_default.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_set_key.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_unregister.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_unregister_all.html create mode 100644 docs/toolkit/manual/silchmac-silc_hmac_update.html create mode 100644 docs/toolkit/manual/silchmac.html create mode 100644 docs/toolkit/manual/silchmac.xref create mode 100644 docs/toolkit/manual/silchttplib.html create mode 100644 docs/toolkit/manual/silchttpphp-silc_http_php.html create mode 100644 docs/toolkit/manual/silchttpphp-silc_http_php_file.html create mode 100644 docs/toolkit/manual/silchttpphp.html create mode 100644 docs/toolkit/manual/silchttpphp.xref create mode 100644 docs/toolkit/manual/silchttpserver-SilcHttpConnection.html create mode 100644 docs/toolkit/manual/silchttpserver-SilcHttpServer.html create mode 100644 docs/toolkit/manual/silchttpserver-SilcHttpServerCallback.html create mode 100644 docs/toolkit/manual/silchttpserver-silc_http_server_add_header.html create mode 100644 docs/toolkit/manual/silchttpserver-silc_http_server_alloc.html create mode 100644 docs/toolkit/manual/silchttpserver-silc_http_server_free.html create mode 100644 docs/toolkit/manual/silchttpserver-silc_http_server_get_header.html create mode 100644 docs/toolkit/manual/silchttpserver-silc_http_server_send.html create mode 100644 docs/toolkit/manual/silchttpserver-silc_http_server_send_error.html create mode 100644 docs/toolkit/manual/silchttpserver.html create mode 100644 docs/toolkit/manual/silchttpserver.xref create mode 100644 docs/toolkit/manual/silcid-SILC_ID_CHANNEL_COMPARE.html create mode 100644 docs/toolkit/manual/silcid-SILC_ID_CLIENT_COMPARE.html create mode 100644 docs/toolkit/manual/silcid-SILC_ID_COMPARE.html create mode 100644 docs/toolkit/manual/silcid-SILC_ID_COMPARE_HASH.html create mode 100644 docs/toolkit/manual/silcid-SILC_ID_COMPARE_TYPE.html create mode 100644 docs/toolkit/manual/silcid-SILC_ID_GET_ID.html create mode 100644 docs/toolkit/manual/silcid-SILC_ID_SERVER_COMPARE.html create mode 100644 docs/toolkit/manual/silcid-SilcChannelID.html create mode 100644 docs/toolkit/manual/silcid-SilcClientID.html create mode 100644 docs/toolkit/manual/silcid-SilcID.html create mode 100644 docs/toolkit/manual/silcid-SilcIDIP.html create mode 100644 docs/toolkit/manual/silcid-SilcIDPayload.html create mode 100644 docs/toolkit/manual/silcid-SilcIdType.html create mode 100644 docs/toolkit/manual/silcid-SilcServerID.html create mode 100644 docs/toolkit/manual/silcid-silc_id_dup.html create mode 100644 docs/toolkit/manual/silcid-silc_id_get_len.html create mode 100644 docs/toolkit/manual/silcid-silc_id_id2str.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_encode.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_encode_data.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_free.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_get_data.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_get_id.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_get_len.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_get_type.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_parse.html create mode 100644 docs/toolkit/manual/silcid-silc_id_payload_parse_id.html create mode 100644 docs/toolkit/manual/silcid-silc_id_str2id.html create mode 100644 docs/toolkit/manual/silcid-silc_id_str2id2.html create mode 100644 docs/toolkit/manual/silcid.html create mode 100644 docs/toolkit/manual/silcid.xref create mode 100644 docs/toolkit/manual/silcidcache-SilcIDCache.html create mode 100644 docs/toolkit/manual/silcidcache-SilcIDCacheDestructor.html create mode 100644 docs/toolkit/manual/silcidcache-SilcIDCacheEntry.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_add.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_alloc.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_del.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_del_by_context.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_del_by_id.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_find_by_context.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_find_by_id.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_find_by_id_one.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_find_by_name.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_find_by_name_one.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_free.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_get_all.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_move.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_update.html create mode 100644 docs/toolkit/manual/silcidcache-silc_idcache_update_by_context.html create mode 100644 docs/toolkit/manual/silcidcache.html create mode 100644 docs/toolkit/manual/silcidcache.xref create mode 100644 docs/toolkit/manual/silclist-SILC_LIST_END.html create mode 100644 docs/toolkit/manual/silclist-SilcList.html create mode 100644 docs/toolkit/manual/silclist-silc_list_add.html create mode 100644 docs/toolkit/manual/silclist-silc_list_count.html create mode 100644 docs/toolkit/manual/silclist-silc_list_del.html create mode 100644 docs/toolkit/manual/silclist-silc_list_end.html create mode 100644 docs/toolkit/manual/silclist-silc_list_get.html create mode 100644 docs/toolkit/manual/silclist-silc_list_init.html create mode 100644 docs/toolkit/manual/silclist-silc_list_init_prev.html create mode 100644 docs/toolkit/manual/silclist-silc_list_insert.html create mode 100644 docs/toolkit/manual/silclist-silc_list_start.html create mode 100644 docs/toolkit/manual/silclist.html create mode 100644 docs/toolkit/manual/silclist.xref create mode 100644 docs/toolkit/manual/silclog-SILC_ASSERT.html create mode 100644 docs/toolkit/manual/silclog-SILC_LOG_DEBUG.html create mode 100644 docs/toolkit/manual/silclog-SILC_LOG_ERROR.html create mode 100644 docs/toolkit/manual/silclog-SILC_LOG_FATAL.html create mode 100644 docs/toolkit/manual/silclog-SILC_LOG_HEXDUMP.html create mode 100644 docs/toolkit/manual/silclog-SILC_LOG_INFO.html create mode 100644 docs/toolkit/manual/silclog-SILC_LOG_WARNING.html create mode 100644 docs/toolkit/manual/silclog-SILC_VERIFY.html create mode 100644 docs/toolkit/manual/silclog-SilcLogCb.html create mode 100644 docs/toolkit/manual/silclog-SilcLogDebugCb.html create mode 100644 docs/toolkit/manual/silclog-SilcLogHexdumpCb.html create mode 100644 docs/toolkit/manual/silclog-SilcLogType.html create mode 100644 docs/toolkit/manual/silclog-silc_log_debug.html create mode 100644 docs/toolkit/manual/silclog-silc_log_debug_hexdump.html create mode 100644 docs/toolkit/manual/silclog-silc_log_flush_all.html create mode 100644 docs/toolkit/manual/silclog-silc_log_flushdelay.html create mode 100644 docs/toolkit/manual/silclog-silc_log_get_file.html create mode 100644 docs/toolkit/manual/silclog-silc_log_quick.html create mode 100644 docs/toolkit/manual/silclog-silc_log_reset_all.html create mode 100644 docs/toolkit/manual/silclog-silc_log_reset_callbacks.html create mode 100644 docs/toolkit/manual/silclog-silc_log_reset_debug_callbacks.html create mode 100644 docs/toolkit/manual/silclog-silc_log_set_callback.html create mode 100644 docs/toolkit/manual/silclog-silc_log_set_debug_callbacks.html create mode 100644 docs/toolkit/manual/silclog-silc_log_set_debug_string.html create mode 100644 docs/toolkit/manual/silclog-silc_log_set_file.html create mode 100644 docs/toolkit/manual/silclog-silc_log_timestamp.html create mode 100644 docs/toolkit/manual/silclog.html create mode 100644 docs/toolkit/manual/silclog.xref create mode 100644 docs/toolkit/manual/silclog_i.html create mode 100644 docs/toolkit/manual/silclog_i.xref create mode 100644 docs/toolkit/manual/silcmath-silc_math_gen_prime.html create mode 100644 docs/toolkit/manual/silcmath-silc_math_prime_test.html create mode 100644 docs/toolkit/manual/silcmath.html create mode 100644 docs/toolkit/manual/silcmath.xref create mode 100644 docs/toolkit/manual/silcmathlib.html create mode 100644 docs/toolkit/manual/silcmemory-silc_calloc.html create mode 100644 docs/toolkit/manual/silcmemory-silc_free.html create mode 100644 docs/toolkit/manual/silcmemory-silc_malloc.html create mode 100644 docs/toolkit/manual/silcmemory-silc_memdup.html create mode 100644 docs/toolkit/manual/silcmemory-silc_realloc.html create mode 100644 docs/toolkit/manual/silcmemory-silc_scalloc.html create mode 100644 docs/toolkit/manual/silcmemory-silc_smalloc.html create mode 100644 docs/toolkit/manual/silcmemory-silc_smalloc_ua.html create mode 100644 docs/toolkit/manual/silcmemory-silc_smemdup.html create mode 100644 docs/toolkit/manual/silcmemory-silc_srealloc.html create mode 100644 docs/toolkit/manual/silcmemory-silc_srealloc_ua.html create mode 100644 docs/toolkit/manual/silcmemory-silc_sstrdup.html create mode 100644 docs/toolkit/manual/silcmemory.html create mode 100644 docs/toolkit/manual/silcmemory.xref create mode 100644 docs/toolkit/manual/silcmessage-SilcMessageFlags.html create mode 100644 docs/toolkit/manual/silcmessage-SilcMessagePayload.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_get_data.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_get_flags.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_get_mac.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_payload_decrypt.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_payload_encode.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_payload_encrypt.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_payload_free.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_payload_parse.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_signed_get_public_key.html create mode 100644 docs/toolkit/manual/silcmessage-silc_message_signed_verify.html create mode 100644 docs/toolkit/manual/silcmessage.html create mode 100644 docs/toolkit/manual/silcmessage.xref create mode 100644 docs/toolkit/manual/silcmessage_i.html create mode 100644 docs/toolkit/manual/silcmessage_i.xref create mode 100644 docs/toolkit/manual/silcmime-SilcMime.html create mode 100644 docs/toolkit/manual/silcmime-SilcMimeAssembler.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_add_data.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_add_field.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_add_multipart.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_alloc.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_assemble.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_assembler_alloc.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_assembler_free.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_decode.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_encode.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_encode_partial.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_free.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_get_data.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_get_field.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_get_multiparts.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_is_multipart.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_is_partial.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_partial_free.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_set_multipart.html create mode 100644 docs/toolkit/manual/silcmime-silc_mime_steal_data.html create mode 100644 docs/toolkit/manual/silcmime.html create mode 100644 docs/toolkit/manual/silcmime.xref create mode 100644 docs/toolkit/manual/silcmime_i.html create mode 100644 docs/toolkit/manual/silcmime_i.xref create mode 100644 docs/toolkit/manual/silcmode-ChannelModes.html create mode 100644 docs/toolkit/manual/silcmode-ChannelUserModes.html create mode 100644 docs/toolkit/manual/silcmode-SilcUserMode.html create mode 100644 docs/toolkit/manual/silcmode.html create mode 100644 docs/toolkit/manual/silcmode.xref create mode 100644 docs/toolkit/manual/silcmp-SilcMPInt.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_abs.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_add.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_add_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_and.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_bin2mp.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_cmp.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_cmp_si.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_cmp_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_div.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_div_2exp.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_div_2exp_qr.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_div_qr.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_div_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_gcd.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_gcdext.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_get_str.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_get_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_init.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mod.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mod_2exp.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mod_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_modinv.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mp2bin.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mp2bin_noalloc.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mul.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mul_2exp.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_mul_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_neg.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_or.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_pow.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_pow_mod.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_pow_mod_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_pow_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_set.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_set_si.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_set_str.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_set_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_size.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_sizeinbase.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_sqrt.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_sub.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_sub_ui.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_uninit.html create mode 100644 docs/toolkit/manual/silcmp-silc_mp_xor.html create mode 100644 docs/toolkit/manual/silcmp.html create mode 100644 docs/toolkit/manual/silcmp.xref create mode 100644 docs/toolkit/manual/silcmutex-SilcMutex.html create mode 100644 docs/toolkit/manual/silcmutex-SilcRwLock.html create mode 100644 docs/toolkit/manual/silcmutex-silc_mutex_alloc.html create mode 100644 docs/toolkit/manual/silcmutex-silc_mutex_assert_locked.html create mode 100644 docs/toolkit/manual/silcmutex-silc_mutex_free.html create mode 100644 docs/toolkit/manual/silcmutex-silc_mutex_lock.html create mode 100644 docs/toolkit/manual/silcmutex-silc_mutex_unlock.html create mode 100644 docs/toolkit/manual/silcmutex-silc_rwlock_alloc.html create mode 100644 docs/toolkit/manual/silcmutex-silc_rwlock_free.html create mode 100644 docs/toolkit/manual/silcmutex-silc_rwlock_rdlock.html create mode 100644 docs/toolkit/manual/silcmutex-silc_rwlock_unlock.html create mode 100644 docs/toolkit/manual/silcmutex-silc_rwlock_wrlock.html create mode 100644 docs/toolkit/manual/silcmutex.html create mode 100644 docs/toolkit/manual/silcmutex.xref create mode 100644 docs/toolkit/manual/silcnet-SilcNetCallback.html create mode 100644 docs/toolkit/manual/silcnet-SilcNetListener.html create mode 100644 docs/toolkit/manual/silcnet-SilcNetResolveCallback.html create mode 100644 docs/toolkit/manual/silcnet-SilcNetStatus.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_accept_connection.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_addr2bin.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_check_host_by_sock.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_check_local_by_sock.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_close_connection.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_close_listener.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_get_error_string.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_get_local_port.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_get_remote_port.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_get_socket_opt.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_gethostbyaddr.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_gethostbyaddr_async.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_gethostbyname.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_gethostbyname_async.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_is_ip.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_is_ip4.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_is_ip6.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_listener_get_hostname.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_listener_get_ip.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_listener_get_port.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_localhost.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_localip.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_set_socket_nonblock.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_set_socket_opt.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_tcp_connect.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_tcp_create_listener.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_udp_connect.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_udp_receive.html create mode 100644 docs/toolkit/manual/silcnet-silc_net_udp_send.html create mode 100644 docs/toolkit/manual/silcnet.html create mode 100644 docs/toolkit/manual/silcnet.xref create mode 100644 docs/toolkit/manual/silcnet_i.html create mode 100644 docs/toolkit/manual/silcnet_i.xref create mode 100644 docs/toolkit/manual/silcnotify-SilcNotifyPayload.html create mode 100644 docs/toolkit/manual/silcnotify-SilcNotifyType.html create mode 100644 docs/toolkit/manual/silcnotify-silc_notify_get_arg_num.html create mode 100644 docs/toolkit/manual/silcnotify-silc_notify_get_args.html create mode 100644 docs/toolkit/manual/silcnotify-silc_notify_get_type.html create mode 100644 docs/toolkit/manual/silcnotify-silc_notify_payload_encode.html create mode 100644 docs/toolkit/manual/silcnotify-silc_notify_payload_encode_args.html create mode 100644 docs/toolkit/manual/silcnotify-silc_notify_payload_free.html create mode 100644 docs/toolkit/manual/silcnotify-silc_notify_payload_parse.html create mode 100644 docs/toolkit/manual/silcnotify.html create mode 100644 docs/toolkit/manual/silcnotify.xref create mode 100644 docs/toolkit/manual/silcpacket-SilcPacket.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketCallbacks.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketEngine.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketEosCb.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketError.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketErrorCb.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketFlags.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketReceiveCb.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketStream.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketType.html create mode 100644 docs/toolkit/manual/silcpacket-SilcPacketWrapCoder.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_engine_free_streams_list.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_engine_get_streams.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_engine_start.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_engine_stop.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_error_string.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_free.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_get_context.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_get_engine.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_get_ids.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_get_keys.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_get_sender.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_send.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_send_ext.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_send_va.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_send_va_ext.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_set_context.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_set_ids.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_set_keys.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_set_sid.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_add_remote.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_create.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_destroy.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_get_stream.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_inject.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_is_udp.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_is_valid.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_link.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_ref.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_set_iv_included.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_set_router.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_set_stream.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_unlink.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_unref.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_stream_wrap.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_wait.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_wait_init.html create mode 100644 docs/toolkit/manual/silcpacket-silc_packet_wait_uninit.html create mode 100644 docs/toolkit/manual/silcpacket.html create mode 100644 docs/toolkit/manual/silcpacket.xref create mode 100644 docs/toolkit/manual/silcpk-SilcPublicKeyIdentifier.html create mode 100644 docs/toolkit/manual/silcpk-SilcSILCPrivateKey.html create mode 100644 docs/toolkit/manual/silcpk-SilcSILCPublicKey.html create mode 100644 docs/toolkit/manual/silcpk-silc_pkcs_silc_decode_identifier.html create mode 100644 docs/toolkit/manual/silcpk-silc_pkcs_silc_encode_identifier.html create mode 100644 docs/toolkit/manual/silcpk-silc_pkcs_silc_generate_key.html create mode 100644 docs/toolkit/manual/silcpk-silc_pkcs_silc_public_key_version.html create mode 100644 docs/toolkit/manual/silcpk.html create mode 100644 docs/toolkit/manual/silcpk.xref create mode 100644 docs/toolkit/manual/silcpk_i.html create mode 100644 docs/toolkit/manual/silcpk_i.xref create mode 100644 docs/toolkit/manual/silcpkcs-SilcPKCSFileEncoding.html create mode 100644 docs/toolkit/manual/silcpkcs-SilcPKCSType.html create mode 100644 docs/toolkit/manual/silcpkcs-SilcPrivateKey.html create mode 100644 docs/toolkit/manual/silcpkcs-SilcPublicKey.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_register.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_unregister.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_decrypt.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_encrypt.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_find_algorithm.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_find_pkcs.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_get_algorithm.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_get_context.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_get_name.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_get_pkcs.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_get_supported.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_get_type.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_load_private_key.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_load_public_key.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_alloc.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_free.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_get_len.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_alloc.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_compare.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_copy.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_export.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_free.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_get_len.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_register.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_register_default.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_save_private_key.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_save_public_key.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_sign.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_unregister.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_unregister_all.html create mode 100644 docs/toolkit/manual/silcpkcs-silc_pkcs_verify.html create mode 100644 docs/toolkit/manual/silcpkcs.html create mode 100644 docs/toolkit/manual/silcpkcs.xref create mode 100644 docs/toolkit/manual/silcpkcs1-SilcPkcs1BlockType.html create mode 100644 docs/toolkit/manual/silcpkcs1-silc_pkcs1_decode.html create mode 100644 docs/toolkit/manual/silcpkcs1-silc_pkcs1_encode.html create mode 100644 docs/toolkit/manual/silcpkcs1.html create mode 100644 docs/toolkit/manual/silcpkcs1.xref create mode 100644 docs/toolkit/manual/silcpkcs1_i.html create mode 100644 docs/toolkit/manual/silcpkcs1_i.xref create mode 100644 docs/toolkit/manual/silcpubkey-silc_public_key_payload_decode.html create mode 100644 docs/toolkit/manual/silcpubkey-silc_public_key_payload_encode.html create mode 100644 docs/toolkit/manual/silcpubkey.html create mode 100644 docs/toolkit/manual/silcpubkey.xref create mode 100644 docs/toolkit/manual/silcrng-SilcRng.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_add_noise.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_alloc.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_free.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_get_byte.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_get_byte_fast.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_get_rn16.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_get_rn32.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_get_rn_data.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_get_rn_string.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_add_noise.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_get_byte.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_get_byte_fast.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_get_rn16.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_get_rn32.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_get_rn_data.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_get_rn_string.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_init.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_global_uninit.html create mode 100644 docs/toolkit/manual/silcrng-silc_rng_init.html create mode 100644 docs/toolkit/manual/silcrng.html create mode 100644 docs/toolkit/manual/silcrng.xref create mode 100644 docs/toolkit/manual/silcrng_intro.html create mode 100644 docs/toolkit/manual/silcschedule-SILC_ALL_TASKS.html create mode 100644 docs/toolkit/manual/silcschedule-SILC_TASK_CALLBACK.html create mode 100644 docs/toolkit/manual/silcschedule-SilcSchedule.html create mode 100644 docs/toolkit/manual/silcschedule-SilcTask.html create mode 100644 docs/toolkit/manual/silcschedule-SilcTaskCallback.html create mode 100644 docs/toolkit/manual/silcschedule-SilcTaskEvent.html create mode 100644 docs/toolkit/manual/silcschedule-SilcTaskNotifyCb.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_get_context.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_get_fd_events.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_init.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_one.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_set_listen_fd.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_set_notify.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_stop.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_add_fd.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_add_signal.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_add_timeout.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_del.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_all.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_callback.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_context.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_fd.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_uninit.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_unset_listen_fd.html create mode 100644 docs/toolkit/manual/silcschedule-silc_schedule_wakeup.html create mode 100644 docs/toolkit/manual/silcschedule.html create mode 100644 docs/toolkit/manual/silcschedule.xref create mode 100644 docs/toolkit/manual/silcschedule_i.html create mode 100644 docs/toolkit/manual/silcschedule_i.xref create mode 100644 docs/toolkit/manual/silcserver-SilcServer.html create mode 100644 docs/toolkit/manual/silcserver-SilcServerRunning.html create mode 100644 docs/toolkit/manual/silcserver-SilcServerStop.html create mode 100644 docs/toolkit/manual/silcserver-silc_server_alloc.html create mode 100644 docs/toolkit/manual/silcserver-silc_server_free.html create mode 100644 docs/toolkit/manual/silcserver-silc_server_run(1).html create mode 100644 docs/toolkit/manual/silcserver-silc_server_run.html create mode 100644 docs/toolkit/manual/silcserver.html create mode 100644 docs/toolkit/manual/silcserver.xref create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_admin.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_cipher.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_client.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_connparam.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_deny.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_hash.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_hmac.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_pkcs.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_router.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_add_server.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_alloc.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_free.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc(1).html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc.html create mode 100644 docs/toolkit/manual/silcserver_params-silc_server_params_set_serverinfo.html create mode 100644 docs/toolkit/manual/silcserver_params.html create mode 100644 docs/toolkit/manual/silcserver_params.xref create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTP.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPAttrCallback.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPAttributes.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPDataCallback.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPErrorCallback.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPExtendedCallback.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPFileOperation.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPHandle.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPHandleCallback.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPMonitor.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPMonitorData.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPMonitors.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPName.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPNameCallback.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPStatus.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPStatusCallback.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPVersion.html create mode 100644 docs/toolkit/manual/silcsftp-SilcSFTPVersionCallback.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_client_shutdown.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_client_start.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_close.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_extended.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_fsetstat.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_fstat.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_lstat.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_mkdir.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_open.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_opendir.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_read.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_readdir.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_readlink.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_realpath.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_remove.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_rename.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_rmdir.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_server_set_monitor.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_server_shutdown.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_server_start.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_setstat.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_stat.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_symlink.html create mode 100644 docs/toolkit/manual/silcsftp-silc_sftp_write.html create mode 100644 docs/toolkit/manual/silcsftp.html create mode 100644 docs/toolkit/manual/silcsftp.xref create mode 100644 docs/toolkit/manual/silcsftp_fs-SilcSFTPFSMemoryPerm.html create mode 100644 docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystem.html create mode 100644 docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystemOps.html create mode 100644 docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_dir.html create mode 100644 docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_file.html create mode 100644 docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_alloc.html create mode 100644 docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_dir.html create mode 100644 docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_file.html create mode 100644 docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_free.html create mode 100644 docs/toolkit/manual/silcsftp_fs.html create mode 100644 docs/toolkit/manual/silcsftp_fs.xref create mode 100644 docs/toolkit/manual/silcsftplib.html create mode 100644 docs/toolkit/manual/silcsim.html create mode 100644 docs/toolkit/manual/silcsim.xref create mode 100644 docs/toolkit/manual/silcsimutil.html create mode 100644 docs/toolkit/manual/silcsimutil.xref create mode 100644 docs/toolkit/manual/silcske-SilcSKECompletionCb.html create mode 100644 docs/toolkit/manual/silcske-SilcSKEKeyMaterial.html create mode 100644 docs/toolkit/manual/silcske-SilcSKEPKType.html create mode 100644 docs/toolkit/manual/silcske-SilcSKEParams.html create mode 100644 docs/toolkit/manual/silcske-SilcSKERekeyMaterial.html create mode 100644 docs/toolkit/manual/silcske-SilcSKESecurityProperties.html create mode 100644 docs/toolkit/manual/silcske-SilcSKESecurityPropertyFlag.html create mode 100644 docs/toolkit/manual/silcske-SilcSKEStatus.html create mode 100644 docs/toolkit/manual/silcske-SilcSKEVerifyCb.html create mode 100644 docs/toolkit/manual/silcske-SilcSKEVerifyCbCompletion.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_alloc.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_free.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_free_key_material.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_free_rekey_material.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_get_context.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_get_key_material.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_get_security_properties.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_initiator.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_map_status.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_parse_version.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_process_key_material_data.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_rekey_initiator.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_rekey_responder.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_responder.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_set_callbacks.html create mode 100644 docs/toolkit/manual/silcske-silc_ske_set_keys.html create mode 100644 docs/toolkit/manual/silcske.html create mode 100644 docs/toolkit/manual/silcske.xref create mode 100644 docs/toolkit/manual/silcske_groups-SilcSKEDiffieHellmanGroup.html create mode 100644 docs/toolkit/manual/silcske_groups-silc_ske_get_supported_groups.html create mode 100644 docs/toolkit/manual/silcske_groups-silc_ske_group_free.html create mode 100644 docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_name.html create mode 100644 docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_number.html create mode 100644 docs/toolkit/manual/silcske_groups-silc_ske_group_get_name.html create mode 100644 docs/toolkit/manual/silcske_groups-silc_ske_group_get_number.html create mode 100644 docs/toolkit/manual/silcske_groups.html create mode 100644 docs/toolkit/manual/silcske_groups.xref create mode 100644 docs/toolkit/manual/silcske_i.html create mode 100644 docs/toolkit/manual/silcske_i.xref create mode 100644 docs/toolkit/manual/silcske_payload-SilcSKEKEPayload.html create mode 100644 docs/toolkit/manual/silcske_payload-SilcSKEStartPayload.html create mode 100644 docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_decode.html create mode 100644 docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_encode.html create mode 100644 docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_free.html create mode 100644 docs/toolkit/manual/silcske_payload-silc_ske_payload_start_decode.html create mode 100644 docs/toolkit/manual/silcske_payload-silc_ske_payload_start_encode.html create mode 100644 docs/toolkit/manual/silcske_payload-silc_ske_payload_start_free.html create mode 100644 docs/toolkit/manual/silcske_payload.html create mode 100644 docs/toolkit/manual/silcske_payload.xref create mode 100644 docs/toolkit/manual/silcskelib.html create mode 100644 docs/toolkit/manual/silcskr-SilcSKR.html create mode 100644 docs/toolkit/manual/silcskr-SilcSKRFind.html create mode 100644 docs/toolkit/manual/silcskr-SilcSKRFindCallback.html create mode 100644 docs/toolkit/manual/silcskr-SilcSKRKey.html create mode 100644 docs/toolkit/manual/silcskr-SilcSKRKeyUsage.html create mode 100644 docs/toolkit/manual/silcskr-SilcSKRStatus.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_add_public_key.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_add_public_key_simple.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_alloc.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_del_public_key.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_add_pkcs_type.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_alloc.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_free.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_context.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_country.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_email.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_host.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_org.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_public_key.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_realname.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_usage.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_find_set_username.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_free.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_init.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_ref_public_key.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_uninit.html create mode 100644 docs/toolkit/manual/silcskr-silc_skr_unref_public_key.html create mode 100644 docs/toolkit/manual/silcskr.html create mode 100644 docs/toolkit/manual/silcskr.xref create mode 100644 docs/toolkit/manual/silcskr_i.html create mode 100644 docs/toolkit/manual/silcskr_i.xref create mode 100644 docs/toolkit/manual/silcskrlib.html create mode 100644 docs/toolkit/manual/silcsnprintf-silc_asprintf.html create mode 100644 docs/toolkit/manual/silcsnprintf-silc_snprintf.html create mode 100644 docs/toolkit/manual/silcsnprintf-silc_vasprintf.html create mode 100644 docs/toolkit/manual/silcsnprintf-silc_vsnprintf.html create mode 100644 docs/toolkit/manual/silcsnprintf.html create mode 100644 docs/toolkit/manual/silcsnprintf.xref create mode 100644 docs/toolkit/manual/silcsocketstream-SilcSocketStreamCallback.html create mode 100644 docs/toolkit/manual/silcsocketstream-SilcSocketStreamStatus.html create mode 100644 docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_error.html create mode 100644 docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_info.html create mode 100644 docs/toolkit/manual/silcsocketstream-silc_socket_stream_is_udp.html create mode 100644 docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_info.html create mode 100644 docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_qos.html create mode 100644 docs/toolkit/manual/silcsocketstream-silc_socket_tcp_stream_create.html create mode 100644 docs/toolkit/manual/silcsocketstream-silc_socket_udp_stream_create.html create mode 100644 docs/toolkit/manual/silcsocketstream.html create mode 100644 docs/toolkit/manual/silcsocketstream.xref create mode 100644 docs/toolkit/manual/silcsocketstream_i.html create mode 100644 docs/toolkit/manual/silcsocketstream_i.xref create mode 100644 docs/toolkit/manual/silcstack-SilcStack.html create mode 100644 docs/toolkit/manual/silcstack-SilcStackFrame.html create mode 100644 docs/toolkit/manual/silcstack-silc_stack_alloc.html create mode 100644 docs/toolkit/manual/silcstack-silc_stack_free.html create mode 100644 docs/toolkit/manual/silcstack-silc_stack_pop.html create mode 100644 docs/toolkit/manual/silcstack-silc_stack_push.html create mode 100644 docs/toolkit/manual/silcstack.html create mode 100644 docs/toolkit/manual/silcstack.xref create mode 100644 docs/toolkit/manual/silcstack_i.html create mode 100644 docs/toolkit/manual/silcstack_i.xref create mode 100644 docs/toolkit/manual/silcstatus-SilcStatus.html create mode 100644 docs/toolkit/manual/silcstatus-silc_status_get_args.html create mode 100644 docs/toolkit/manual/silcstatus.html create mode 100644 docs/toolkit/manual/silcstatus.xref create mode 100644 docs/toolkit/manual/silcstatus_args.html create mode 100644 docs/toolkit/manual/silcstream-SilcStream.html create mode 100644 docs/toolkit/manual/silcstream-SilcStreamNotifier.html create mode 100644 docs/toolkit/manual/silcstream-SilcStreamOps.html create mode 100644 docs/toolkit/manual/silcstream-SilcStreamStatus.html create mode 100644 docs/toolkit/manual/silcstream-silc_stream_close.html create mode 100644 docs/toolkit/manual/silcstream-silc_stream_destroy.html create mode 100644 docs/toolkit/manual/silcstream-silc_stream_get_schedule.html create mode 100644 docs/toolkit/manual/silcstream-silc_stream_read.html create mode 100644 docs/toolkit/manual/silcstream-silc_stream_set_notifier.html create mode 100644 docs/toolkit/manual/silcstream-silc_stream_write.html create mode 100644 docs/toolkit/manual/silcstream.html create mode 100644 docs/toolkit/manual/silcstream.xref create mode 100644 docs/toolkit/manual/silcstringprep-SilcStringprepFlags.html create mode 100644 docs/toolkit/manual/silcstringprep-SilcStringprepStatus.html create mode 100644 docs/toolkit/manual/silcstringprep-silc_stringprep.html create mode 100644 docs/toolkit/manual/silcstringprep.html create mode 100644 docs/toolkit/manual/silcstringprep.xref create mode 100644 docs/toolkit/manual/silcstrutil-SilcStringEncoding.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_base64_encode.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_base64_encode_file.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_base_decode.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_string_compare.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_string_match.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_string_regex_match.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_string_regexify.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_string_split.html create mode 100644 docs/toolkit/manual/silcstrutil-silc_strncat.html create mode 100644 docs/toolkit/manual/silcstrutil.html create mode 100644 docs/toolkit/manual/silcstrutil.xref create mode 100644 docs/toolkit/manual/silcsymbiansocketstream.html create mode 100644 docs/toolkit/manual/silcsymbiansocketstream.xref create mode 100644 docs/toolkit/manual/silcthread-SilcThread.html create mode 100644 docs/toolkit/manual/silcthread-SilcThreadStart.html create mode 100644 docs/toolkit/manual/silcthread-silc_thread_create.html create mode 100644 docs/toolkit/manual/silcthread-silc_thread_exit.html create mode 100644 docs/toolkit/manual/silcthread-silc_thread_self.html create mode 100644 docs/toolkit/manual/silcthread-silc_thread_wait.html create mode 100644 docs/toolkit/manual/silcthread-silc_thread_yield.html create mode 100644 docs/toolkit/manual/silcthread.html create mode 100644 docs/toolkit/manual/silcthread.xref create mode 100644 docs/toolkit/manual/silctime-SilcTime.html create mode 100644 docs/toolkit/manual/silctime-silc_compare_timeval.html create mode 100644 docs/toolkit/manual/silctime-silc_gettimeofday.html create mode 100644 docs/toolkit/manual/silctime-silc_time.html create mode 100644 docs/toolkit/manual/silctime-silc_time_generalized.html create mode 100644 docs/toolkit/manual/silctime-silc_time_generalized_string.html create mode 100644 docs/toolkit/manual/silctime-silc_time_msec.html create mode 100644 docs/toolkit/manual/silctime-silc_time_string.html create mode 100644 docs/toolkit/manual/silctime-silc_time_universal.html create mode 100644 docs/toolkit/manual/silctime-silc_time_universal_string.html create mode 100644 docs/toolkit/manual/silctime-silc_time_usec.html create mode 100644 docs/toolkit/manual/silctime-silc_time_value.html create mode 100644 docs/toolkit/manual/silctime-silc_timezone.html create mode 100644 docs/toolkit/manual/silctime-silc_usleep.html create mode 100644 docs/toolkit/manual/silctime.html create mode 100644 docs/toolkit/manual/silctime.xref create mode 100644 docs/toolkit/manual/silctypes-FALSE.html create mode 100644 docs/toolkit/manual/silctypes-SILC_32_TO_PTR.html create mode 100644 docs/toolkit/manual/silctypes-SILC_64_TO_PTR.html create mode 100644 docs/toolkit/manual/silctypes-SILC_GET16_LSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_GET16_MSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_GET32_LSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_GET32_MSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_GET64_MSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_PTR_TO_32.html create mode 100644 docs/toolkit/manual/silctypes-SILC_PTR_TO_64.html create mode 100644 docs/toolkit/manual/silctypes-SILC_PUT16_LSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_PUT16_MSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_PUT32_LSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_PUT32_MSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_PUT64_MSB.html create mode 100644 docs/toolkit/manual/silctypes-SILC_SWAB_16.html create mode 100644 docs/toolkit/manual/silctypes-SILC_SWAB_32.html create mode 100644 docs/toolkit/manual/silctypes-SilcBool.html create mode 100644 docs/toolkit/manual/silctypes-SilcInt16.html create mode 100644 docs/toolkit/manual/silctypes-SilcInt32.html create mode 100644 docs/toolkit/manual/silctypes-SilcInt64.html create mode 100644 docs/toolkit/manual/silctypes-SilcInt8.html create mode 100644 docs/toolkit/manual/silctypes-SilcSocket.html create mode 100644 docs/toolkit/manual/silctypes-SilcUInt16.html create mode 100644 docs/toolkit/manual/silctypes-SilcUInt32.html create mode 100644 docs/toolkit/manual/silctypes-SilcUInt64.html create mode 100644 docs/toolkit/manual/silctypes-SilcUInt8.html create mode 100644 docs/toolkit/manual/silctypes-TRUE.html create mode 100644 docs/toolkit/manual/silctypes.html create mode 100644 docs/toolkit/manual/silctypes.xref create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_c2w.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_decode.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_decoded_len.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_encode.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_encoded_len.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_strcasecmp.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_strncasecmp.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_valid.html create mode 100644 docs/toolkit/manual/silcutf8-silc_utf8_w2c.html create mode 100644 docs/toolkit/manual/silcutf8.html create mode 100644 docs/toolkit/manual/silcutf8.xref create mode 100644 docs/toolkit/manual/silcutil-silc_check_line.html create mode 100644 docs/toolkit/manual/silcutil-silc_fingerprint.html create mode 100644 docs/toolkit/manual/silcutil-silc_format.html create mode 100644 docs/toolkit/manual/silcutil-silc_get_input.html create mode 100644 docs/toolkit/manual/silcutil-silc_get_real_name.html create mode 100644 docs/toolkit/manual/silcutil-silc_get_username.html create mode 100644 docs/toolkit/manual/silcutil-silc_gets.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_client_id_compare.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_client_id_hash.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_data.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_data_compare.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_id.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_id_compare.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_id_compare_full.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_ptr.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_public_key.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_public_key_compare.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_string.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_string_compare.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_uint.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_utf8_compare.html create mode 100644 docs/toolkit/manual/silcutil-silc_hash_utf8_string.html create mode 100644 docs/toolkit/manual/silcutil-silc_parse_command_line.html create mode 100644 docs/toolkit/manual/silcutil-silc_parse_userfqdn.html create mode 100644 docs/toolkit/manual/silcutil-silc_string_is_ascii.html create mode 100644 docs/toolkit/manual/silcutil-silc_to_lower.html create mode 100644 docs/toolkit/manual/silcutil-silc_to_upper.html create mode 100644 docs/toolkit/manual/silcutil-silc_va_copy.html create mode 100644 docs/toolkit/manual/silcutil.html create mode 100644 docs/toolkit/manual/silcutil.xref create mode 100644 docs/toolkit/manual/silcutillib.html create mode 100644 docs/toolkit/manual/silcvcard-SilcVCard.html create mode 100644 docs/toolkit/manual/silcvcard-silc_vcard_alloc.html create mode 100644 docs/toolkit/manual/silcvcard-silc_vcard_decode.html create mode 100644 docs/toolkit/manual/silcvcard-silc_vcard_encode.html create mode 100644 docs/toolkit/manual/silcvcard-silc_vcard_fprintf.html create mode 100644 docs/toolkit/manual/silcvcard-silc_vcard_free.html create mode 100644 docs/toolkit/manual/silcvcard.html create mode 100644 docs/toolkit/manual/silcvcard.xref create mode 100644 docs/toolkit/manual/silcvcardlib.html create mode 100644 docs/toolkit/manual/space.gif create mode 100644 docs/toolkit/manual/toolkit_index.html create mode 100644 docs/toolkit/manual/zlib.html diff --git a/docs/client/ChangeLog b/docs/client/ChangeLog new file mode 100644 index 0000000..d98fa74 --- /dev/null +++ b/docs/client/ChangeLog @@ -0,0 +1,407 @@ +commit b953803ae59ea3e66e3ed799b90dbb66a9002fce +Author: Pekka Riikonen +Date: Tue May 6 12:24:10 2014 +0300 + + silc-client: handle prompt abort better + + When verfying public key abort any previously ungoing prompt so that we + can get the public key verification prompt up. It's important to not + loose the public key verification prompts so we now allow new prompt to + come up after previous one has aborted. It leaks Irssi memory, but + handles things correctly towards silcclient library. Irssi's prompt + handling is broken because it stores the data in a global variable + allowing only one prompt at a time. + +commit bd463a75d37dd2ec164dc14dee4bb2550d6a778a +Author: Pekka Riikonen +Date: Mon May 5 13:53:08 2014 +0300 + + silcclient: check packet type as responder before starting AKE + + Do not immediately start the private message key autonegotiation as + responder when a packet comes in but wait until it is decoded from the + private message payload so that responder can properly set up the SKE + properties and start the SKE in proper state. Initiator is allowed to + start SKE with SILC_PACKET_KEY_EXCHANGE at any time, including when a key + already exists and it would be error to expect that initiator should have + sent SILC_PACKET_KEY_EXCHANGE_1 just because key exists in responder side. + +commit c849f909fc98a2460ffc1c7becf17b7417e391e7 +Author: Pekka Riikonen +Date: Mon May 5 11:23:48 2014 +0300 + + Fix compilation warnings + +commit 0a948452f74af6a7440cee4243c54ed8bb534b13 +Author: Pekka Riikonen +Date: Mon May 5 11:23:33 2014 +0300 + + silc-client: rpm packaging updates + +commit 0c5b4cf8af092fd6c3d3d4cd03efd299c7020cc1 +Author: Pekka Riikonen +Date: Tue Apr 29 10:56:24 2014 +0300 + + SKE: handle invalid protocol state errors + + With SKE over UDP we can receive packets in wrong order or do + retransmissions but in TCP receiving wrong SKE packet at wrong time is + a protocol error and must result to end of the key exchange. + +commit 79b406da2cc03883eb2da6c8c69ff2d7a9356df9 +Author: Pekka Riikonen +Date: Mon Apr 28 23:01:30 2014 +0300 + + irssi: better public key print out + + When verifying public key show more information about it. + +commit 80d10dbf48785c2163551a7f94a46f6f5849c4a7 +Author: Pekka Riikonen +Date: Mon Apr 28 22:59:28 2014 +0300 + + silcclient: auto-negotiation of private message key using SKE over SILCnet + + Previously in SILC private messages have been protected in normal mode + using the session key shared between the client and server and other + servers in the network. This obviously has security implications if + the SILC servers cannot be trusted. + + To overcome this issue silcclient library has offered user the ability to + use pre-shared key (or password) as the secret key to protect private + message, or to negotiate fresh key material using SKE peer-to-peer over + the internet (key agreement). + + However, both of these feature have severe limitations. The first one + requiring coordinated effort to somehow share the key or password and + the second requiring peer-to-peer connection which may not be possible + due to NAT and firewalls. + + This commit adds a new private message protection method and takes it + into use as the default protection method. The commits adds support + for automatic negotiation of the private message key using SKE but instead + of doing it peer-to-peer over the internet it is done client-to-client + over the SILC network itself. This is accomplished by tunneling the + SKE protocol inside private message packets. As SKE is safe over the + unprotected and untrusted internet it is safe also over the SILC network. + + The end result of the auto-negotiation is a shared secret known only + to the two clients. The SKE provides mutual authentication with digital + signatures to prevent man-in-the-middle attack. The private messages + protected with this key can be read only by the two clients. SILC servers + along the way cannot decrypt them. The key is periodically re-keyed + (5 minutes or so) and it provides Perfect Forward Secrecy. + + The auto-negotiation is enabled by default. It can detect within seconds + if the remote client supports the method and if it doesn't it gives a + notification that the private message protection has been reverted back + to session keys. Application can disable the feature, if wanted. + + This feature does not require any changes to SILC servers. + +commit d7f1e81fea0d1da2ac870b8dfa600669aa280cd5 +Author: Pekka Riikonen +Date: Mon Apr 28 22:43:44 2014 +0300 + + silcclient: fix packet stream coder function + + Generate correct FTP packet after, after the packet stream coder function + semantics changed in commit 705167687caeaa66c371dce7cc88719687337b9e. + +commit 77774e96ef3f5011bb85f7e0ec68a7f3a4a4d6e8 +Author: Pekka Riikonen +Date: Mon Apr 28 22:42:43 2014 +0300 + + silcclient: Add generic client entry operation context + + Add generic client entry async operation context to the internal + context. Change the key agreement to start using it. + + Add support for aborting client entry operations when the client entry + is deleted or when the connection is closed to the server. + +commit 7f26bf8964b7269f9a9f295afdff1b870ecc68e2 +Author: Pekka Riikonen +Date: Mon Apr 28 22:39:06 2014 +0300 + + SKE: support for simplified key exchange + + This commit adds support for simplified SILC Key Exchange protocol by + allowing the caller to specify the security properties to be used in + the key exchange. This will stop the library from exchanging the + SILC_PACKET_KEY_EXCHANGE packet containing the properties. + + Support for not sending the SILC_PACKET_SUCCESS acks after a successful + key exchange. + + These two changes allow the SKE to be simplified to exchanging only + the SILC_PACKET_KEY_EXHANGE_1 and SILC_PACKET_KEY_EXCHANGE_2 packets + to produce the shared key and to do mutual authentication. + + The commit also adds support for generating small proposals in + SILC_PACKET_KEY_EXCHANGE packet by including only one security property + per item instead of listing all of them in the proposal. + + Additionally the commit adds support for probe timeout which affects + the first packet sent by initiator. If responder does not respond to + the first packet in the specified timeframe the key exchange will + timeout. If it replies the normal key exchange timeout has effect after + that. + +commit 705167687caeaa66c371dce7cc88719687337b9e +Author: Pekka Riikonen +Date: Mon Apr 28 22:31:35 2014 +0300 + + silccore: packet injection and stream wrap improvements + + Add silc_packet_stream_inject to allow injecting of packets to the + specified packet stream. + + Add support for specifying the source and destination ids for the + wrapped packet stream allowing to use them in packet sending and using + them in packet reception to take only packets with the specified ids. + + The semantics of CAN_WRITE and CAN_READ of wrapped packet stream coder + function has been changed to allow the coder to filter out packets it + does not want or to handle errors in coding. + +commit 0b9028b4a1bf48ee0eea4ff231d302b24ccb924d +Author: Pekka Riikonen +Date: Mon Apr 28 21:49:23 2014 +0300 + + Targeted library message to correct Irssi window + + Add support for sending the library generated say-operation messages + to correct window using either nickname or channel name as the target. + Irssi does the rest to show the message in correct window. + +commit 7ba30123577540d59575c8f020bad86c52c21f59 +Author: Pekka Riikonen +Date: Mon Apr 28 21:47:58 2014 +0300 + + Targeted say-operation messages + + Add support for including the client, channel or server with the say() + client operation library can generate. This allows application to + better target the message to correct window or recipient. + +commit d0c0355c2fa9ef0aa699010242479366c06b7041 +Author: Pekka Riikonen +Date: Mon Apr 28 15:05:58 2014 +0300 + + Fix file transfer crash + + When silc-client accepts new file transfer and receives public key to + verify it will crash because the client connection has no Irssi server + associated to it. Handle this gracefully. + + Call the sucessful public key verify completion after the key has been + saved because the completion callback may free the public key. + +commit 2559c5da3d5353f97f16b387bff02373b258a3df +Author: Pekka Riikonen +Date: Sun Apr 27 10:38:34 2014 +0300 + + Static analyzer fixes + + More small fixes resulting from clang static analysis. + +commit 644f8b14010e05d55b5cde8514f6efdca8c21c5b +Author: Pekka Riikonen +Date: Tue Apr 22 15:29:07 2014 +0300 + + Enable higher security messages MACs + + The code to include the source and destination ID in the message payload + MAC has been there for a long time but the use of it has been disabled. + This commit enables it but preserves the backwards support for those + clients unable to verify the MACs. The support for the newer MACs + have been there for several years. + +commit e7ecca35b79220f947ae30c98f80688db1d2a101 +Author: Pekka Riikonen +Date: Tue Apr 22 15:26:55 2014 +0300 + + Remove obsolete backwards support code + + Remove the old zero-client id backwards support when starting SKE protocol. + +commit 40df0fe9d2a0a7648a111ca03de16f7a740cf5ad +Author: Pekka Riikonen +Date: Tue Apr 22 15:25:37 2014 +0300 + + Longer default PKCS keys + + This commit changes the default PKCS key length from 2048 bits to 4096 + bits. It adds warnings to both SILC client and SILC server in start up + in case the existing key is shorter than 4096 to encourage people to + generate new key longer key pair. + + This commit also changes the default SKE DH group from 1024 to 1536 bits. + The old group is still supported. + +commit d4ead7075692a4abdc487fcb422cb9fd5b41a596 +Author: Pekka Riikonen +Date: Tue Apr 22 15:22:38 2014 +0300 + + Static analyzer bug fixes + + Bunch of small bugs fixed here and there found during static analysis. + +commit f38b21315fc72df3914664227ebcece766f01f66 +Author: Pekka Riikonen +Date: Fri Jun 22 22:21:38 2012 +0300 + + Mac OS X >= 10.7 support + + Add support for compiling on Mac OS X > 10.7 and newer. Summary of + changes: + + - Remove config.guess and config.sub, let the autodist copy proper + versions from the system. + + - Add support for autoconfg 2.68 and newer. + + - Add support for compiing x86-64 AES code with NASM. + + - Update Mac OS X installation instructions. + +commit 27a4ad25c65fa7b4fdbbe53b3551a687a9b43214 +Author: Pekka Riikonen +Date: Tue May 25 07:24:28 2010 +0300 + + Client: Fix signature verification double free + + When client receives public key in the message payload and is compared + against the client's own public key, when the keys differ we have to + return immediately and not try to verify the signature. + +commit a2f2afc03242a6f8b77953203f8e3767a6e703c4 +Author: Pekka Riikonen +Date: Tue May 11 07:44:09 2010 +0300 + + Packet engine: prevent divide by 0 + +commit 5fff0bf9cd2c72027c9f42f2e60b415ba4848ae6 +Author: Pekka Riikonen +Date: Tue May 11 07:41:03 2010 +0300 + + SKE: Make sure failure received from remote is error status. + +commit bb61286f7ac90ebcdaa9b00991a9a98b6cd8663f +Author: Pekka Riikonen +Date: Fri Sep 25 12:07:41 2009 +0300 + + Set SO_KEEPALIVE for all accept()ed sockets. + +commit 80bb7b35c2a1f44702631f1a5cf5685d5ce4b2c7 +Author: Pekka Riikonen +Date: Fri Sep 25 12:06:45 2009 +0300 + + clientlib: Close connection after failed rekey + +commit 8cb801cf6482666818e721822ce81c81ec818908 +Author: Pekka Riikonen +Date: Fri Aug 7 14:48:46 2009 +0300 + + More string format fixes in silcd and client libary + +commit 97fa30748eed3f4248bd213ae3ab9e742fd36c71 +Author: Pekka Riikonen +Date: Sun Aug 2 10:11:20 2009 +0300 + + configure: changed AC_PROG_LIBTOOL order to fix disabling shared libs + + .cvsignore => .gitignore | 18 + + INSTALL | 3 + + README | 114 +- + README.MACOSX | 33 +- + TODO | 304 +- + apps/irssi/silc-client.spec.in | 11 +- + apps/irssi/src/perl/silc/Makefile.PL.in | 2 +- + apps/irssi/src/silc/core/client_ops.c | 98 +- + apps/irssi/src/silc/core/clientutil.c | 22 +- + apps/irssi/src/silc/core/silc-channels.c | 2 + + apps/irssi/src/silc/core/silc-core.h | 2 +- + apps/irssi/src/silc/core/silc-queries.c | 6 +- + apps/irssi/src/silc/core/silc-servers.c | 11 +- + config.guess | 1471 ----- + config.sub | 1599 ----- + configure.ad | 64 +- + distdir/pre-run | 2 +- + lib/Makefile.ad | 8 +- + lib/configure.ad | 16 +- + lib/contrib/nfkc.c | 3 + + lib/doc/LIBINDEX | 2 +- + lib/silcapputil/silcapputil.c | 4 +- + lib/silcapputil/silcapputil.h | 2 +- + lib/silcasn1/silcasn1.c | 4 +- + lib/silcasn1/silcasn1_decode.c | 2 +- + lib/silcasn1/silcasn1_encode.c | 2 +- + lib/silcclient/client.c | 27 +- + lib/silcclient/client.h | 11 +- + lib/silcclient/client_attrs.c | 2 +- + lib/silcclient/client_channel.c | 20 +- + lib/silcclient/client_connect.c | 14 +- + lib/silcclient/client_entry.c | 22 +- + lib/silcclient/client_ftp.c | 17 +- + lib/silcclient/client_internal.h | 6 +- + lib/silcclient/client_keyagr.c | 32 +- + lib/silcclient/client_listener.c | 2 +- + lib/silcclient/client_notify.c | 2 +- + lib/silcclient/client_prvmsg.c | 720 ++- + lib/silcclient/client_prvmsg.h | 12 +- + lib/silcclient/client_register.c | 2 +- + lib/silcclient/command.c | 8 +- + lib/silcclient/command_reply.c | 12 +- + lib/silcclient/silcclient.h | 24 +- + lib/silcclient/tests/test_silcclient.c | 4 +- + lib/silccore/silcargument.c | 2 - + lib/silccore/silcattrs.c | 9 +- + lib/silccore/silcauth.c | 2 +- + lib/silccore/silcmessage.c | 21 +- + lib/silccore/silcmessage.h | 5 +- + lib/silccore/silcpacket.c | 145 +- + lib/silccore/silcpacket.h | 60 +- + lib/silccore/tests/test_silcmessage.c | 4 +- + lib/silccrypt/aes.c | 18 +- + lib/silccrypt/aes_x86_64.asm | 8 +- + lib/silccrypt/md5.c | 2 +- + lib/silccrypt/silccipher.c | 3 +- + lib/silccrypt/silchash.c | 3 +- + lib/silccrypt/silchmac.c | 3 +- + lib/silccrypt/silcpk.h | 4 +- + lib/silccrypt/silcpkcs.c | 3 +- + lib/silccrypt/silcpkcs1.c | 32 +- + lib/silccrypt/silcrng.c | 18 +- + lib/silccrypt/tests/test_silcpkcs.c | 4 +- + lib/silccrypt/twofish.c | 2 +- + lib/silchttp/silchttpserver.c | 3 + + lib/silcmath/mp_gmp.c | 3 +- + lib/silcmath/mp_tfm.c | 3 +- + lib/silcmath/mp_tma.c | 3 +- + lib/silcmath/silcmp.h | 2 +- + lib/silcmath/tma.c | 5 + + lib/silcserver/tests/test_silcserver.c | 2 +- + lib/silcsftp/sftp_fs_memory.c | 2 + + lib/silcske/groups.c | 44 +- + lib/silcske/payload.c | 11 +- + lib/silcske/silcske.c | 531 +- + lib/silcske/silcske.h | 23 +- + lib/silcske/silcske_groups.h | 7 +- + lib/silcske/silcske_i.h | 4 +- + lib/silcutil/Makefile.ad | 2 - + lib/silcutil/silcbuffmt.c | 4 +- + lib/silcutil/silcfileutil.c | 2 +- + lib/silcutil/silcmemory.h | 4 - + lib/silcutil/silcmime.c | 5 +- + lib/silcutil/silcnet.c | 54 +- + lib/silcutil/silcschedule.c | 9 +- + lib/silcutil/silctime.c | 8 +- + lib/silcutil/stacktrace.c | 58 +- + lib/silcutil/unix/silcunixnet.c | 1 + + silc-toolkit.spec.in | 250 +- + 180 files changed, 15547 insertions(+), 8216 deletions(-) + rename .cvsignore => .gitignore (70%) + delete mode 100755 config.guess + delete mode 100755 config.sub diff --git a/docs/client/ReleaseNotes b/docs/client/ReleaseNotes new file mode 100644 index 0000000..5716ca5 --- /dev/null +++ b/docs/client/ReleaseNotes @@ -0,0 +1 @@ +bar diff --git a/docs/server/ChangeLog b/docs/server/ChangeLog new file mode 100644 index 0000000..ede4cde --- /dev/null +++ b/docs/server/ChangeLog @@ -0,0 +1,213 @@ +commit f2deb55ad9290c1d13fa33b3a3cb3dac9318b28e +Author: Pekka Riikonen +Date: Mon May 5 11:40:55 2014 +0300 + + silc-server: rpm packaging updates + +commit 46f0bec9f20c9914bb333ec6b1247e5dc2a04199 +Author: Pekka Riikonen +Date: Sun May 4 18:13:45 2014 +0300 + + silcd: allow ServerType, Location, Admin and AdminEmail to be empty + +commit 83656203e4a4c5d3e2d63785f8ecb7de0dd5ae0b +Author: Pekka Riikonen +Date: Sun May 4 17:59:06 2014 +0300 + + Example silcd.conf file that connects to sauna.silcnet.org directly. + +commit 0c5b4cf8af092fd6c3d3d4cd03efd299c7020cc1 +Author: Pekka Riikonen +Date: Tue Apr 29 10:56:24 2014 +0300 + + SKE: handle invalid protocol state errors + + With SKE over UDP we can receive packets in wrong order or do + retransmissions but in TCP receiving wrong SKE packet at wrong time is + a protocol error and must result to end of the key exchange. + +commit 581d2aecadb68f43e70691001d772fe46b459e24 +Author: Pekka Riikonen +Date: Mon Apr 28 23:00:55 2014 +0300 + + silcd: show MAC in welcome notifys + + Shoe cipher and MAC currently in use in the welcome messages servers sends + to client. + +commit 7f26bf8964b7269f9a9f295afdff1b870ecc68e2 +Author: Pekka Riikonen +Date: Mon Apr 28 22:39:06 2014 +0300 + + SKE: support for simplified key exchange + + This commit adds support for simplified SILC Key Exchange protocol by + allowing the caller to specify the security properties to be used in + the key exchange. This will stop the library from exchanging the + SILC_PACKET_KEY_EXCHANGE packet containing the properties. + + Support for not sending the SILC_PACKET_SUCCESS acks after a successful + key exchange. + + These two changes allow the SKE to be simplified to exchanging only + the SILC_PACKET_KEY_EXHANGE_1 and SILC_PACKET_KEY_EXCHANGE_2 packets + to produce the shared key and to do mutual authentication. + + The commit also adds support for generating small proposals in + SILC_PACKET_KEY_EXCHANGE packet by including only one security property + per item instead of listing all of them in the proposal. + + Additionally the commit adds support for probe timeout which affects + the first packet sent by initiator. If responder does not respond to + the first packet in the specified timeframe the key exchange will + timeout. If it replies the normal key exchange timeout has effect after + that. + +commit 705167687caeaa66c371dce7cc88719687337b9e +Author: Pekka Riikonen +Date: Mon Apr 28 22:31:35 2014 +0300 + + silccore: packet injection and stream wrap improvements + + Add silc_packet_stream_inject to allow injecting of packets to the + specified packet stream. + + Add support for specifying the source and destination ids for the + wrapped packet stream allowing to use them in packet sending and using + them in packet reception to take only packets with the specified ids. + + The semantics of CAN_WRITE and CAN_READ of wrapped packet stream coder + function has been changed to allow the coder to filter out packets it + does not want or to handle errors in coding. + +commit 2559c5da3d5353f97f16b387bff02373b258a3df +Author: Pekka Riikonen +Date: Sun Apr 27 10:38:34 2014 +0300 + + Static analyzer fixes + + More small fixes resulting from clang static analysis. + +commit 40df0fe9d2a0a7648a111ca03de16f7a740cf5ad +Author: Pekka Riikonen +Date: Tue Apr 22 15:25:37 2014 +0300 + + Longer default PKCS keys + + This commit changes the default PKCS key length from 2048 bits to 4096 + bits. It adds warnings to both SILC client and SILC server in start up + in case the existing key is shorter than 4096 to encourage people to + generate new key longer key pair. + + This commit also changes the default SKE DH group from 1024 to 1536 bits. + The old group is still supported. + +commit d4ead7075692a4abdc487fcb422cb9fd5b41a596 +Author: Pekka Riikonen +Date: Tue Apr 22 15:22:38 2014 +0300 + + Static analyzer bug fixes + + Bunch of small bugs fixed here and there found during static analysis. + +commit f38b21315fc72df3914664227ebcece766f01f66 +Author: Pekka Riikonen +Date: Fri Jun 22 22:21:38 2012 +0300 + + Mac OS X >= 10.7 support + + Add support for compiling on Mac OS X > 10.7 and newer. Summary of + changes: + + - Remove config.guess and config.sub, let the autodist copy proper + versions from the system. + + - Add support for autoconfg 2.68 and newer. + + - Add support for compiing x86-64 AES code with NASM. + + - Update Mac OS X installation instructions. + + .cvsignore => .gitignore | 18 + + INSTALL | 3 + + README | 114 +- + README.MACOSX | 33 +- + TODO | 304 +- + apps/silcd/command.c | 174 +- + apps/silcd/command_reply.c | 12 +- + apps/silcd/idlist.c | 12 + + apps/silcd/packet_receive.c | 19 +- + apps/silcd/packet_send.c | 20 +- + apps/silcd/server.c | 74 +- + apps/silcd/server.h | 6 +- + apps/silcd/server_backup.c | 33 +- + apps/silcd/server_internal.h | 1 + + apps/silcd/server_query.c | 8 +- + apps/silcd/server_util.c | 9 +- + apps/silcd/server_util.h | 14 +- + apps/silcd/serverconfig.c | 21 +- + apps/silcd/serverid.c | 4 + + apps/silcd/silc-server.spec.in | 4 +- + apps/silcd/silcd.c | 38 +- + config.guess | 1471 ----- + config.sub | 1599 ----- + configure.ad | 64 +- + distdir/pre-run | 2 +- + doc/example_silcd.conf.in | 34 +- + lib/Makefile.ad | 8 +- + lib/configure.ad | 16 +- + lib/contrib/nfkc.c | 3 + + lib/doc/LIBINDEX | 2 +- + lib/silcapputil/silcapputil.c | 4 +- + lib/silcapputil/silcapputil.h | 2 +- + lib/silcasn1/silcasn1.c | 4 +- + lib/silcasn1/silcasn1_decode.c | 2 +- + lib/silcasn1/silcasn1_encode.c | 2 +- + lib/silccore/silcargument.c | 2 - + lib/silccore/silcattrs.c | 9 +- + lib/silccore/silcauth.c | 2 +- + lib/silccore/silcmessage.c | 21 +- + lib/silccore/silcmessage.h | 5 +- + lib/silccore/silcpacket.c | 145 +- + lib/silccore/silcpacket.h | 60 +- + lib/silccore/tests/test_silcmessage.c | 4 +- + lib/silccrypt/aes.c | 18 +- + lib/silccrypt/aes_x86_64.asm | 8 +- + lib/silccrypt/md5.c | 2 +- + lib/silccrypt/silccipher.c | 3 +- + lib/silccrypt/silchash.c | 3 +- + lib/silccrypt/silchmac.c | 3 +- + lib/silccrypt/silcpk.h | 4 +- + lib/silccrypt/silcpkcs.c | 3 +- + lib/silccrypt/silcpkcs1.c | 32 +- + lib/silccrypt/silcrng.c | 18 +- + lib/silccrypt/tests/test_silcpkcs.c | 4 +- + lib/silccrypt/twofish.c | 2 +- + lib/silchttp/silchttpserver.c | 3 + + lib/silcmath/mp_gmp.c | 3 +- + lib/silcmath/mp_tfm.c | 3 +- + lib/silcmath/mp_tma.c | 3 +- + lib/silcmath/silcmp.h | 2 +- + lib/silcmath/tma.c | 5 + + lib/silcserver/tests/test_silcserver.c | 2 +- + lib/silcsftp/sftp_fs_memory.c | 2 + + lib/silcske/groups.c | 44 +- + lib/silcske/payload.c | 11 +- + lib/silcske/silcske.c | 531 +- + lib/silcske/silcske.h | 23 +- + lib/silcske/silcske_groups.h | 7 +- + lib/silcske/silcske_i.h | 4 +- + lib/silcutil/Makefile.ad | 2 - + lib/silcutil/silcbuffmt.c | 4 +- + lib/silcutil/silcfileutil.c | 2 +- + lib/silcutil/silcmemory.h | 4 - + lib/silcutil/silcmime.c | 5 +- + lib/silcutil/silcnet.c | 54 +- + lib/silcutil/silcschedule.c | 9 +- + lib/silcutil/silctime.c | 8 +- + lib/silcutil/stacktrace.c | 58 +- + lib/silcutil/unix/silcunixnet.c | 1 + + 180 files changed, 15547 insertions(+), 8216 deletions(-) + rename .cvsignore => .gitignore (70%) + delete mode 100755 config.guess + delete mode 100755 config.sub diff --git a/docs/silcd.conf.5 b/docs/silcd.conf.5 new file mode 100644 index 0000000..15ed3e4 --- /dev/null +++ b/docs/silcd.conf.5 @@ -0,0 +1,584 @@ +SILCD_CONF(5) silc-server SILCD_CONF(5) + + + +NAME + silcd.conf - format of configuration file for silcd + + +CONFIGURATION FILE + Silcd reads its configuration from /etc/silc/silcd.conf (or the file + specified with -f). The file contains sections, subsections and + key-value pairs. Each section or subsection is bound with a starting { + and ending }. Keys and values are of the format 'KEY=VALUE;'. All + statements as well as sections must be terminated with a ';'. + + Mandatory section in configuration file is ServerInfo. Other sections + are optional but recommended. If General section is defined it must be + defined before the ConnectionParams section. On the other hand, the + ConnectionParams section must be defined before Client, ServerConnec- + tion and/or RouterConnection sections. Other sections can be in a free + order in the configuration file. + + +SECTION: General + General section contains global settings for the silcd. + + dynamic_server + Dynamic router connections. If this is set for normal SILC + server the connection to primary router is not created untill it + is actually needed. Giving for example /WHOIS foobar@silc- + net.org would then create connection to the primary router to + resolve user foobar. On the other hand giving /WHOIS foobar + would try to search the user foobar locally, without creating + the connection. Note that giving /JOIN foobar will also created + the connection as current SILC Server version supports only + global channels (all JOINs require connection to router, if one + is configured). + + + prefer_passphrase_auth + If both public key and passphrase authentication are set for a + connection, public key authentication is by default preferred. + Setting this value to true causes silcd to prefer passphrase + authentication in these cases. + + + require_reverse_lookup + Set this value to true if all connecting hosts must have a fully + qualified domain name (FQDN). If set to true, a host without + FQDN is not allowed to connect to server. + + + connections_max + Maximum number of incoming connections to this server. Any fur- + ther connections are refused. + + + connections_max_per_host + Maximum number of incoming connections from any single host. + This setting can be overridden on a connection-specific basis + with ConnectionParams. + + + version_protocol + Defines the minimum required version of protocol to allow con- + necting to server. A client or server using this version of pro- + tocol or newer is allowed to connect, one using anything older + will be rejected. Leaving unset allows all versions to connect. + This can be overridden with ConnectionParams. + + + version_software + Defines the minimum required version of software to allow con- + necting to server. A client or server that is of this version or + newer is allowed to connect, one using anything older will be + rejected. Leaving unset allows all versions to connect. This + can be overridden with ConnectionParams. + + + version_software_vendor + Defines the allowed software vendor string that is required to + connect. Usually this is either a build number or special + client tag. Using this requirement is not encouraged unless the + server is in very limited use. Leaving unset allows all ver- + sions regardless of their vendor to connect. Can be overridden + with ConnectionParams. + + + key_exchange_rekey + Defines the interval, in seconds, how often the session key will + be regenerated. This setting only applies to the connection ini- + tiator, as rekey is always performed by the initiating party. + Setting has effect only when the server acts as an initiator, + and can be overridden with ConnectionParams. + + + key_exchange_pfs + Boolean value to determine, whether key-exchange is performed + with Perfect Forward Secrecy (PFS) or without. If set to true, + the rekey process will be somewhat slower, but more secure since + the key is entirely regenerated. Can be overridden with Connec- + tionParams. + + + key_exchange_timeout + Key exchange timeout in seconds. If the key exchange is not com- + pleted within this time, the remote connection will be closed. + + + conn_auth_timeout + Connection authentication timeout in seconds. If the connection + authentication is not completed within this time, the remote + connection will be closed. + + + channel_rekey_secs + Seconds, how often channel key will be regenerated. Note that + channel key is regenerated each time someone joins or leaves the + channel. This is the maximum time any channel can have the same + key. + + + detach_disabled + Boolean value controlling, whether clients are denied the use of + DETACH command. Default value is false (DETACH is allowed). + + + detach_timeout + Time in seconds how long detached sessions will be available. By + default, detached sessions do not expire and as such, are per- + sistent as long as the server is running. If DETACH command is + allowed, this value should be set as well. + + + qos + Boolean value controlling, whether Quality of Service settings + are enabled. Default setting is false. NOTE: If you enable QoS + in general section, it applies to every connection the server + has, including server connections. This setting can be overrid- + den with ConnectionParams and in case of server connections, it + SHOULD BE overridden (server connections should not use QoS). + + + qos_rate_limit + Limits read operations per second to given amount. Do note that + one read operation may read several SILC packets, so this set- + ting does not automatically correspond to amount of messages + transmitted or accepted. + + + qos_bytes_limit + Limits incoming SILC data to the specified number of bytes per + second. + + + qos_limit_sec + This value defines the timeout, in seconds, for the delay of + received data in case it was left in a QoS queue. + + + qos_limit_usec + This value defines the timeout, in microseconds, for the delay + of received data for received data in case it was left in a QoS + queue. + + + +SECTION: ServerInfo + ServerInfo contains values for bound interfaces and administrative + info. + + hostname + Server's name (FQDN). + + + ServerType + This is a descriptive text field, usually telling what the + server and its purpose are. + + + Location + Descriptive field of server's geographic location. + + + Admin + Administrator's full name. + + + AdminEmail + Administrator's email address. + + + User + The name of the user account silcd will be running on. This must + be an existing user. Silcd needs to executed as root; after + binding the port it will drop root privileges and use the + account given here. + + + Group + The name of the group silcd will be running on. This must be an + existing group. Silcd needs to be executed as root; after bind- + ing the port it will drop root privileges and use the group + given here. + + + PublicKey + Full path to server's public key file. + + + PrivateKey + Full path to server's private key file. + + + MotdFile + Full path to MOTD (Message Of The Day) file, a text file that + will be displayed to each client upon connection. + + + PidFile + Full path to file where silcd will write its PID. + + + +SUBSECTION: Primary + This is the primary listener info. Each server can have no more than + one Primary section. + + ip + Specifies the address silcd is listening on. + + + port + Specifies the port silcd is listening on. + + + public_ip + Optional field. If your server is behind NAT this IP would be + the public IP address. The 'ip' field would include the inter- + nal IP address. With this option it is possible to run silcd + behind NAT device. + + + +SUBSECTION: Secondary + This is a secondary listener info. A server may have any amount of Sec- + ondary listener settings. These are needed only if silcd needs to lis- + ten on several interfaces. Secondary subsections have the same informa- + tion that Primary does. + + +SECTION: Logging + This section is used to set up various log files; their paths, maximum + sizes and individual logging options. + + There are four defined logging channels. The log channels have an + importance value, and more important channels are always redirected to + the less important ones. Setting a valid logging file for Info will + ensure logging for all channels, whereas a setting for Errors would + only ensure logging for Errors and Fatals. + + Timestamp + A boolean value that dictates whether log lines will have time- + stamps prefixed. In general, this is a good idea. You might want + to disable this if you are running silcd under some special log- + ging daemon, such as daemontools. + + + QuickLogs + A boolean value that determines how often log files are updated. + Setting this to true makes silcd log in real-time. Setting this + to false makes silcd write to logs every FlushDelay seconds. + Real-time logging causes a bit more CPU and HDD usage but + reduces memory consumption. + + + FlushDelay + Time in seconds, how often logs are flushed to logfiles. This + setting has effect only if QuickLogs is disabled. + + + +SUBSECTION: Info +SUBSECTION: Warnings +SUBSECTION: Errors +SUBSECTION: Fatals + Each of these subsections has the same attributes, File and Size. Dif- + ferent levels of problems are logged to their respective channels + (Info, Warnings, Errors, Fatals), depending on their need of attention. + + File + Full path to log file. + + + Size + Limit the size the log file is allowed to grow to. Any further + messages to this file cause the oldest lines to be removed in + order to keep the file size within given limit. + + + +SECTION: ConnectionParams + This section defines connection parameters. Each connection may have + its own set of ConnectionParams but having one is in no way mandatory. + If no separate parameters have been assigned, the defaults and the ones + from General section will be used. A silcd configuration may have any + number of ConnectionParams sections. + + name + This is a unique name that separates this particular Connection- + Params section from all the others. It is also the name with + which settings are referred to a given set of parameters. This + field is mandatory. + + + connections_max + Limits how many concurrent connections are allowed. Any further + connections are simply refused. Note that this setting can not + override the figure given in General section. + + + connections_max_per_host + Maximum number of connections allowed from any single host. If + this parameter is set for a block controlling server connec- + tions, it is highly suggested to use a value of one (1). + + + version_protocol + Exactly the same as in General section. + + + version_software + Exactly the same as in General section. + + + version_software_vendor + Exactly the same as in General section. + + + keepalive_secs + How often (seconds) to send HEARTBEAT packets to connected + clients. + + + reconnect_count + When connection is lost, how many times a reconnection is tried. + + + reconnect_interval + How often, in seconds, a reconnection is attempted. + + + reconnect_interval_max + Reconnection time is lengthened each time an unsuccessful + attempt occurs. This value defines the maximum interval to which + the delay may be prolonged. + + + reconnect_keep_trying + Boolean value controlling whether server eventually gives up + trying to reconnect. If set to false, server will give up once + reconnect_count is reached or, even at maximum interval no con- + nection is established. + + + key_exchange_rekey + Exactly the same as in General section. + + + key_exchange_pfs + Exactly the same as in General section. + + + anonymous + This boolean setting has meaning only to client connections. If + set to true, client connections using this ConnectionParams + block will have their username and host scrambled. The client + will also have an anonymous mode set to it. + + + qos + Exactly the same as in General section NOTE: For server connec- + tion this should be set to false value. + + + qos_rate_limit + Exactly the same as in General section. + + + qos_bytes_limit + Exactly the same as in General section. + + + qos_limit_sec + Exactly the same as in General section. + + + qos_limit_usec + Exactly the same as in General section. + + + +SECTION: Client + This section defines how incoming client connections are handled. There + can be several Client sections, each with their own requirements. A + silcd admin could for example require that connections from certain + IP-address space must supply a connection password. + + Host + An address or wildcarded set of addresses, either in numeric + IP-address fashion or as hostnames. For example "10.1.*" or + "*.mydomain.domain.org". + + + Passphrase + The required passphrase to allow client connection. + + + PublicKey + The path to a file containing the client's public key. There can + be any number of PublicKey statements in one Client section. + Matching any of them will do. + + + Params + Name of client connection parameters. + + + +SECTION: ServerConnection + This section defines a configured server connection. A regular SILC + server does not need one at all. If this block exists, it means that + the server is a SILC router. There must be one ServerConnection for + each SILC server that connects to this router. + + Host + Either an FQDN or strict IP-address of the connecting server. + + + Passphrase + If server connection requires passphrase authentication, set it + here. + + + PublicKey + This is a path to connecting server's public key. If server con- + nection requires public key authentication, set this value. If + both Passphrase and PublicKey are set, then either of them will + be accepted. + + + Params + Connection parameters. + + + Backup + A boolean value controlling whether this server acts as a + backup. Set to false for normal servers. If set to true, this + server is a backup router. + + + +SECTION: RouterConnection + This section covers router connections. Stand-alone servers won't have + this section, and regular servers should only have one. + + Router servers need one RouterConnection for each other router they + have been configured to connect to. First configured section is the + primary route. + + Port + If Initiator is set tro true, this setting defines the remote + port in which to connect. if Initiator is set to false, then + this defines the local (listening) port. + + + Passphrase + If connecting server requires a passphrase authentication, it is + set here. + + + PublicKey + If connecting to server requires public key authentication, the + path to server's public key file is set here. + + + Params + Connection parameters. + + + Initiator + A boolean setting that defines whether this server is the con- + necting party. + + + BackupHost + If the configured connection is a backup connection, set this to + the address of the main router that will be replaced. For normal + router connection leave this option out. + + + BackupPort + If the configured connection is a backup connection, set this to + the remote port which to connect to. For normal router connec- + tion, leave this option out. + + + BackupLocal + A boolean value. If this setting is true, then the backup router + is in the same cell. If the backup router is in another cell, + set this to false. Needless to say, for normal router connec- + tion, leave this option out. + + + +SECTION: Admin + This section defines configured administration connections. + + Host + Either FQDN or a strict IP-address to the origin of connection. + This field is optional. + + + User + Username that the connecting client announces. This field is + optional. + + + Nick + Nickname that the connecting client announces. This field is + optional. + + + Passphrase + Passphrase required to obtain server operator privileges. + + + PublicKey + Path to administrator's public key file. If both Passphrase and + PublicKey are defined, either one can be used. + + + +SECTION: Deny + This section defines denied incoming connections. They apply equally to + both client and server connections, so make sure you know what you add + here. Each Deny section covers one instance of denied connection(s). + There may be any number of Deny sections. + + Host + Address or wildcarded addresses of denied connections. NOTE! + This field is not mandatory, but highly recommended. If you + don't specify Host at all, or give it a value of "*", you have a + silcd that denies every single incoming connection. + + + Reason + A string giving the reason as to why the connecting party is not + allowed to connect. Unlike Host, this field IS mandatory. + + + +FILES + silcd.conf + + +SEE ALSO + silcd(8) + + +AUTHOR + SILC is designed and written by Pekka Riikonen and + rest of the SILC Project. + + Configuration file format and parser is by Giovanni Giacobbi . + + This manpage was written by Mika 'Bostik' Bostrom + + See CREDITS for full list of contributors. + + + +silc-server November 2 2002 SILCD_CONF(5) diff --git a/docs/silcd.pub b/docs/silcd.pub new file mode 100644 index 0000000..848315c --- /dev/null +++ b/docs/silcd.pub @@ -0,0 +1,14 @@ +-----BEGIN SILC PUBLIC KEY----- +AAACaQADcnNhAFhVTj1zaWxjLCBITj1zaWxjbmV0Lm9yZywgUk49U0lMQyBQcm9qZWN0LCB +FPXNpbGNAc2lsY25ldC5vcmcsIE89U0lMQyBQcm9qZWN0LCBDPVNsb3Zha2lhAAAAAv/9AA +ACAH3RgPdxUvBWjOjzpI/MJGEYdCe8Zoz/+REqHOutBIunQ0y6yeK77exND6rugnXbZNFcq +WFM3lVkQjwMPBtQqVEdh6HtHtWCDP1Xp4uQMg9JETZ0OI8a8HIEuTEM3TWaslgb57GCNYGu +HANZ60/8eKJP2mm7RNcWC1gENdLdsDd7FJ9tjXmZq+f+ZOFqKxFxTmarkW6+eZhF5FFfdyu +SQqbEXaNn+VWvBpIJ7CFYBGUMLj+zYjtDCdO6DlM2OwI1wQxQdpPLQGoo8wvNCSDuOdYqZP +wHZ/kRgQhnurRtYOaUQYaSLZP0Wx1v7mA4w/2TGiLYwmek7Vb0mQB0hPNpCBZWlCN3Z/MbE +krwCWe5lG4ZkH+s8ftL2H+Yq4Hn8UaEacYWyZSvfmVH/f8S2M1hSQ4c3dmVejx8ds/0RveF +f951dqJn3Zvl9lYe1vi1v8o54QkvhZPKlbcspmRlKQp/TEbeUCubZoSjkE9goPBOT38vHXJ +dKMNJNApA0sUExLJv/zrx3Bh8UsOy6+ecQHRUnCPwPQrYscdjpqvI1ScE67k0NSVF5PnvWj +k7AmwigscBydGiEs5SMYhxYEDoWDnLwa0A+zeihLwmHLUAiwFwyqnJOuGm3tBTSfCe56wrb +GzbCZGxLUQwtl+zWZQ7plQ8Vv8UJb0PCqBU5pi53/Ks9sHn +-----END SILC PUBLIC KEY----- diff --git a/docs/silcnet_silcd.conf b/docs/silcnet_silcd.conf new file mode 100644 index 0000000..25c71b3 --- /dev/null +++ b/docs/silcnet_silcd.conf @@ -0,0 +1,14 @@ +# +# This snippet shows an example RouterConnection entry for SILC server +# to automatically connect to SILCNet. +# +# Refer to the example_silcd.conf and/or silcd.conf(5) manual page for +# all configuration options. +# + +# Automatically connect to SILCNet +RouterConnection { + Host = "sauna.silcnet.org"; + Port = 706; + Initiator = true; +}; diff --git a/docs/toolkit/ChangeLog b/docs/toolkit/ChangeLog new file mode 100644 index 0000000..e15f48f --- /dev/null +++ b/docs/toolkit/ChangeLog @@ -0,0 +1,356 @@ +commit bd463a75d37dd2ec164dc14dee4bb2550d6a778a +Author: Pekka Riikonen +Date: Mon May 5 13:53:08 2014 +0300 + + silcclient: check packet type as responder before starting AKE + + Do not immediately start the private message key autonegotiation as + responder when a packet comes in but wait until it is decoded from the + private message payload so that responder can properly set up the SKE + properties and start the SKE in proper state. Initiator is allowed to + start SKE with SILC_PACKET_KEY_EXCHANGE at any time, including when a key + already exists and it would be error to expect that initiator should have + sent SILC_PACKET_KEY_EXCHANGE_1 just because key exists in responder side. + +commit c849f909fc98a2460ffc1c7becf17b7417e391e7 +Author: Pekka Riikonen +Date: Mon May 5 11:23:48 2014 +0300 + + Fix compilation warnings + +commit b7c5d77228c07bf2974e986c362e5fb0014f9fff +Author: Pekka Riikonen +Date: Mon May 5 11:24:08 2014 +0300 + + silc-toolkit: rpm packaging updates + +commit 0c5b4cf8af092fd6c3d3d4cd03efd299c7020cc1 +Author: Pekka Riikonen +Date: Tue Apr 29 10:56:24 2014 +0300 + + SKE: handle invalid protocol state errors + + With SKE over UDP we can receive packets in wrong order or do + retransmissions but in TCP receiving wrong SKE packet at wrong time is + a protocol error and must result to end of the key exchange. + +commit fb7bc4b5172fd6fa0ae96f876a33cd2ec5139b6e +Author: Pekka Riikonen +Date: Mon Apr 28 23:00:02 2014 +0300 + + Bump version numbers + + Bump library version numbers, API has changed. + +commit 80d10dbf48785c2163551a7f94a46f6f5849c4a7 +Author: Pekka Riikonen +Date: Mon Apr 28 22:59:28 2014 +0300 + + silcclient: auto-negotiation of private message key using SKE over SILCnet + + Previously in SILC private messages have been protected in normal mode + using the session key shared between the client and server and other + servers in the network. This obviously has security implications if + the SILC servers cannot be trusted. + + To overcome this issue silcclient library has offered user the ability to + use pre-shared key (or password) as the secret key to protect private + message, or to negotiate fresh key material using SKE peer-to-peer over + the internet (key agreement). + + However, both of these feature have severe limitations. The first one + requiring coordinated effort to somehow share the key or password and + the second requiring peer-to-peer connection which may not be possible + due to NAT and firewalls. + + This commit adds a new private message protection method and takes it + into use as the default protection method. The commits adds support + for automatic negotiation of the private message key using SKE but instead + of doing it peer-to-peer over the internet it is done client-to-client + over the SILC network itself. This is accomplished by tunneling the + SKE protocol inside private message packets. As SKE is safe over the + unprotected and untrusted internet it is safe also over the SILC network. + + The end result of the auto-negotiation is a shared secret known only + to the two clients. The SKE provides mutual authentication with digital + signatures to prevent man-in-the-middle attack. The private messages + protected with this key can be read only by the two clients. SILC servers + along the way cannot decrypt them. The key is periodically re-keyed + (5 minutes or so) and it provides Perfect Forward Secrecy. + + The auto-negotiation is enabled by default. It can detect within seconds + if the remote client supports the method and if it doesn't it gives a + notification that the private message protection has been reverted back + to session keys. Application can disable the feature, if wanted. + + This feature does not require any changes to SILC servers. + +commit d7f1e81fea0d1da2ac870b8dfa600669aa280cd5 +Author: Pekka Riikonen +Date: Mon Apr 28 22:43:44 2014 +0300 + + silcclient: fix packet stream coder function + + Generate correct FTP packet after, after the packet stream coder function + semantics changed in commit 705167687caeaa66c371dce7cc88719687337b9e. + +commit 77774e96ef3f5011bb85f7e0ec68a7f3a4a4d6e8 +Author: Pekka Riikonen +Date: Mon Apr 28 22:42:43 2014 +0300 + + silcclient: Add generic client entry operation context + + Add generic client entry async operation context to the internal + context. Change the key agreement to start using it. + + Add support for aborting client entry operations when the client entry + is deleted or when the connection is closed to the server. + +commit 7f26bf8964b7269f9a9f295afdff1b870ecc68e2 +Author: Pekka Riikonen +Date: Mon Apr 28 22:39:06 2014 +0300 + + SKE: support for simplified key exchange + + This commit adds support for simplified SILC Key Exchange protocol by + allowing the caller to specify the security properties to be used in + the key exchange. This will stop the library from exchanging the + SILC_PACKET_KEY_EXCHANGE packet containing the properties. + + Support for not sending the SILC_PACKET_SUCCESS acks after a successful + key exchange. + + These two changes allow the SKE to be simplified to exchanging only + the SILC_PACKET_KEY_EXHANGE_1 and SILC_PACKET_KEY_EXCHANGE_2 packets + to produce the shared key and to do mutual authentication. + + The commit also adds support for generating small proposals in + SILC_PACKET_KEY_EXCHANGE packet by including only one security property + per item instead of listing all of them in the proposal. + + Additionally the commit adds support for probe timeout which affects + the first packet sent by initiator. If responder does not respond to + the first packet in the specified timeframe the key exchange will + timeout. If it replies the normal key exchange timeout has effect after + that. + +commit 705167687caeaa66c371dce7cc88719687337b9e +Author: Pekka Riikonen +Date: Mon Apr 28 22:31:35 2014 +0300 + + silccore: packet injection and stream wrap improvements + + Add silc_packet_stream_inject to allow injecting of packets to the + specified packet stream. + + Add support for specifying the source and destination ids for the + wrapped packet stream allowing to use them in packet sending and using + them in packet reception to take only packets with the specified ids. + + The semantics of CAN_WRITE and CAN_READ of wrapped packet stream coder + function has been changed to allow the coder to filter out packets it + does not want or to handle errors in coding. + +commit 2d1796c19aaf7b3e1f07f95e0271e64fdea1da2f +Author: Pekka Riikonen +Date: Mon Apr 28 21:55:33 2014 +0300 + + Robodoc compilation update + + Update robodoc compilation. + +commit 39e99da8fc2c49fe989ef50b040866f735fefd5b +Author: Pekka Riikonen +Date: Sun Apr 27 10:48:43 2014 +0300 + + Use backtrace() in stack tracing for prettier output + + This commit takes the backtrace() call in use to produce stack trace + outputs, plus it gives us x86-64 support for stack trace. + +commit 2559c5da3d5353f97f16b387bff02373b258a3df +Author: Pekka Riikonen +Date: Sun Apr 27 10:38:34 2014 +0300 + + Static analyzer fixes + + More small fixes resulting from clang static analysis. + +commit 644f8b14010e05d55b5cde8514f6efdca8c21c5b +Author: Pekka Riikonen +Date: Tue Apr 22 15:29:07 2014 +0300 + + Enable higher security messages MACs + + The code to include the source and destination ID in the message payload + MAC has been there for a long time but the use of it has been disabled. + This commit enables it but preserves the backwards support for those + clients unable to verify the MACs. The support for the newer MACs + have been there for several years. + +commit e7ecca35b79220f947ae30c98f80688db1d2a101 +Author: Pekka Riikonen +Date: Tue Apr 22 15:26:55 2014 +0300 + + Remove obsolete backwards support code + + Remove the old zero-client id backwards support when starting SKE protocol. + +commit 40df0fe9d2a0a7648a111ca03de16f7a740cf5ad +Author: Pekka Riikonen +Date: Tue Apr 22 15:25:37 2014 +0300 + + Longer default PKCS keys + + This commit changes the default PKCS key length from 2048 bits to 4096 + bits. It adds warnings to both SILC client and SILC server in start up + in case the existing key is shorter than 4096 to encourage people to + generate new key longer key pair. + + This commit also changes the default SKE DH group from 1024 to 1536 bits. + The old group is still supported. + +commit d4ead7075692a4abdc487fcb422cb9fd5b41a596 +Author: Pekka Riikonen +Date: Tue Apr 22 15:22:38 2014 +0300 + + Static analyzer bug fixes + + Bunch of small bugs fixed here and there found during static analysis. + +commit f38b21315fc72df3914664227ebcece766f01f66 +Author: Pekka Riikonen +Date: Fri Jun 22 22:21:38 2012 +0300 + + Mac OS X >= 10.7 support + + Add support for compiling on Mac OS X > 10.7 and newer. Summary of + changes: + + - Remove config.guess and config.sub, let the autodist copy proper + versions from the system. + + - Add support for autoconfg 2.68 and newer. + + - Add support for compiing x86-64 AES code with NASM. + + - Update Mac OS X installation instructions. + +commit 27a4ad25c65fa7b4fdbbe53b3551a687a9b43214 +Author: Pekka Riikonen +Date: Tue May 25 07:24:28 2010 +0300 + + Client: Fix signature verification double free + + When client receives public key in the message payload and is compared + against the client's own public key, when the keys differ we have to + return immediately and not try to verify the signature. + +commit a2f2afc03242a6f8b77953203f8e3767a6e703c4 +Author: Pekka Riikonen +Date: Tue May 11 07:44:09 2010 +0300 + + Packet engine: prevent divide by 0 + +commit 5fff0bf9cd2c72027c9f42f2e60b415ba4848ae6 +Author: Pekka Riikonen +Date: Tue May 11 07:41:03 2010 +0300 + + SKE: Make sure failure received from remote is error status. + +commit bb61286f7ac90ebcdaa9b00991a9a98b6cd8663f +Author: Pekka Riikonen +Date: Fri Sep 25 12:07:41 2009 +0300 + + Set SO_KEEPALIVE for all accept()ed sockets. + +commit 80bb7b35c2a1f44702631f1a5cf5685d5ce4b2c7 +Author: Pekka Riikonen +Date: Fri Sep 25 12:06:45 2009 +0300 + + clientlib: Close connection after failed rekey + + .cvsignore => .gitignore | 18 + + INSTALL | 3 + + README | 114 +- + README.MACOSX | 33 +- + TODO | 304 +- + config.guess | 1471 ----- + config.sub | 1599 ----- + configure.ad | 62 +- + distdir/pre-run | 2 +- + lib/Makefile.ad | 8 +- + lib/configure.ad | 16 +- + lib/contrib/nfkc.c | 3 + + lib/doc/LIBINDEX | 2 +- + lib/silcapputil/silcapputil.c | 4 +- + lib/silcapputil/silcapputil.h | 2 +- + lib/silcasn1/silcasn1.c | 4 +- + lib/silcasn1/silcasn1_decode.c | 2 +- + lib/silcasn1/silcasn1_encode.c | 2 +- + lib/silcclient/client.c | 27 +- + lib/silcclient/client.h | 11 +- + lib/silcclient/client_attrs.c | 2 +- + lib/silcclient/client_channel.c | 20 +- + lib/silcclient/client_connect.c | 14 +- + lib/silcclient/client_entry.c | 22 +- + lib/silcclient/client_ftp.c | 17 +- + lib/silcclient/client_internal.h | 6 +- + lib/silcclient/client_keyagr.c | 32 +- + lib/silcclient/client_listener.c | 2 +- + lib/silcclient/client_notify.c | 2 +- + lib/silcclient/client_prvmsg.c | 720 ++- + lib/silcclient/client_prvmsg.h | 12 +- + lib/silcclient/client_register.c | 2 +- + lib/silcclient/command_reply.c | 12 +- + lib/silcclient/silcclient.h | 24 +- + lib/silcclient/tests/test_silcclient.c | 4 +- + lib/silccore/silcargument.c | 2 - + lib/silccore/silcattrs.c | 9 +- + lib/silccore/silcauth.c | 2 +- + lib/silccore/silcmessage.c | 21 +- + lib/silccore/silcmessage.h | 5 +- + lib/silccore/silcpacket.c | 145 +- + lib/silccore/silcpacket.h | 60 +- + lib/silccore/tests/test_silcmessage.c | 4 +- + lib/silccrypt/aes.c | 18 +- + lib/silccrypt/aes_x86_64.asm | 8 +- + lib/silccrypt/md5.c | 2 +- + lib/silccrypt/silccipher.c | 3 +- + lib/silccrypt/silchash.c | 3 +- + lib/silccrypt/silchmac.c | 3 +- + lib/silccrypt/silcpk.h | 4 +- + lib/silccrypt/silcpkcs.c | 3 +- + lib/silccrypt/silcpkcs1.c | 32 +- + lib/silccrypt/silcrng.c | 18 +- + lib/silccrypt/tests/test_silcpkcs.c | 4 +- + lib/silccrypt/twofish.c | 2 +- + lib/silchttp/silchttpserver.c | 3 + + lib/silcmath/mp_gmp.c | 3 +- + lib/silcmath/mp_tfm.c | 3 +- + lib/silcmath/mp_tma.c | 3 +- + lib/silcmath/silcmp.h | 2 +- + lib/silcmath/tma.c | 5 + + lib/silcserver/tests/test_silcserver.c | 2 +- + lib/silcsftp/sftp_fs_memory.c | 2 + + lib/silcske/groups.c | 44 +- + lib/silcske/payload.c | 11 +- + lib/silcske/silcske.c | 531 +- + lib/silcske/silcske.h | 23 +- + lib/silcske/silcske_groups.h | 7 +- + lib/silcske/silcske_i.h | 4 +- + lib/silcutil/Makefile.ad | 2 - + lib/silcutil/silcbuffmt.c | 4 +- + lib/silcutil/silcfileutil.c | 2 +- + lib/silcutil/silcmemory.h | 4 - + lib/silcutil/silcmime.c | 5 +- + lib/silcutil/silcnet.c | 54 +- + lib/silcutil/silcschedule.c | 9 +- + lib/silcutil/silctime.c | 8 +- + lib/silcutil/stacktrace.c | 58 +- + lib/silcutil/unix/silcunixnet.c | 1 + + silc-toolkit.spec.in | 250 +- + 179 files changed, 15541 insertions(+), 8210 deletions(-) + rename .cvsignore => .gitignore (70%) + delete mode 100755 config.guess + delete mode 100755 config.sub diff --git a/docs/toolkit/manual/arch.gif b/docs/toolkit/manual/arch.gif new file mode 100644 index 0000000000000000000000000000000000000000..92a0d3cc3b3dcf4b3edd4d7ecaf2792c23b04a97 GIT binary patch literal 119513 zcmc$lg;E?^vxRYoAi>?8;O;KL-QC^Yb#P~Z!JWa~gAVR)ArRaWToNYt{7-S$6LfXg z?y6qv+X_nZfLO)rLA3O zY}{yV-RkVz>FwPc96T5uJ(83(k(D)FSU6u%u?z;UwYP6uSTuWhbf>3JKE1v|q0qvC z|Fl0md@we4I6Hg1x_Z8|b3MDa_v6PePR=}hD=QLPTM7pUS{D~4cXu`~FK$0S{(u0H zkPyl6aM`FR<=EKcwE2pQYVsx|~0%@F{Zl9a$SzH`hU!U088dzCbJv`h#IoUry|9O3V z{_EG(-QC^O)4%_3QA6=%ylgFfY;CCg9eo_AbR2A{6qHmoV5r{^V9{X0Vc7mRqW=vG z1{oRw6BQj38yBAdNK8sjNli=7$jr*l$;|`i7Zieuic3n%$}2#y)it$s_27Cq*e1Bv zw)T$Bu2%RSxL){y!EeJOqho^z6Yvm(>6y9tg~cTV#Fe#G#Es4Eo!z~CM5KemA4ors zPtVRTE|HM0Z;@|)-#~fAZO%QJT|SePi=%% zR3gzAv+>%}ipex889x(FE!gQS2GwGd;kK&TJWfOI^j?eV`2v38^S$Zz8uemKA0+Y_ zi`r!*#Vi)nnT|;KO7#liqDv~Lb+AFZ)8Kol(`GZ)u=uNRSHpI@!>lw>f7cCsHxzpZ zQl!$|wBL(!bh?jj*?fQ!0gq1c)c_kjmSD~t*V)6>FxhQ)vQw4R_GLCV6z7jEM*i92 zbb2hsAR9@$wnx#K-4`+;t zKL4N$(PJd`tw<)>0_chW3q58?i*AzGWsPkf#mPz$f~ngpeGA z@`Q*dIU)<(76$_>&VnN}mgI?hG@FcVZeqK9+v;sQNx0Q*?qV+50>`CNs9ynht)=!n zU&9C_#iiAh)>!E1xY}5FAb*V1<9EwLA#iM48{{?1K563ZB7Sx%g{5o1?~7+^Un6%A zifk4@opNTcbW+q!5zMv!Xcm&NVP6s|`)0ou4uiyWp^Z!eq>3`OMI(p?W%5zSI=1HI z##Sa?Qk(d1<6D_hcO{ks!W)SUlA;EQtdn^*0)95}9|5gxfsPy2U-}VHjWQ;&>yjPj zIFf958ta~qo!68NZC$r^s&9n4Tme|XUlF9$qBgloAg`&9tm-}&q(?iS-weYQ@vm5HM+kS4)V z51nJHE~Z%CK+mAGyy`HH&0BCYp0lQ&Fp;O^brT#`$K;%ZyA{OB$}`hr&^!b++O`q7 z$7O4U@TWAi&xl`r%~Gj9J$BYK3bxJZvE6p<{vLKgFLadYd@D9_7tPUk-6fJPeYc_V zYryBbv!*=h$-d^dkM}?BO0X5(D?x~OLB9{tCgZczlD?p=g?@T?G1nweQ7(p23Tvs5dItbGVEn4`bp1)Ng#{X=rUybZ&(Ci&4?k^Ac3CoO$6zyedK9eC?o4 z_{n!oi--AUeaFW2CcDEnu&{eA>&Cd}Fg5U5)UkQjPXg-N|6#JXp7Sq#&-dre{`YI| zHUERdkNo0c1U#eK-~`qtho8wJP>=Dys8lCRgu^hlY~H!b7Ev9z+>2thHsvDQ=X05T zT4l<k(!#pM1x1Wo}zr+ZLTKYf&CPgyW z^x8!?L>-M5(c`h(W9eP;;a!Yzcb_0tVuvp7u2UEBFB@x3{;CRU-e61ho>i1z_7|o&f+9!X-k#D2_bVMhhgb3sSqQo*q31x z-RgKPTU;3k@NAsS$+Do8H8}W7j~~1Fw+-8%n?k2}iIEl^r&*936)R-O#buOcDoC<{ zgtE-*5a(49t0y0LGOq1Rz#|jkP7m?~bJU{iQkmL76ADhSqi1L!T!q3Y6XYB0Tr#}O zPn9*`H$MJ3&n=%d7)GR0VKpa7lJ@LV{+Cwq)UVRv82bpi@>98G9CisNrnIJr(}k*D zoE=BRs7emfyH(i!10)5@=@8ngkJ~Ih(T!Dk$C+bxr5wG7Lza^6&T|~D+_p+H_7R;f zW8pi1lSro&%4#+ z`CgI;VJ@JMab@^b$F@wRC7(E6n|Q%Ws3P|KLp>QnnFWm!a2r*=%j;3B{y1!+C^jO45nH^_Lb_Ay;?*1eZjP&K4nw2yG&SH@$Wt2DE3La&y! za!k_H-X^y#S|-;*M{*RnHx;9C1j?TyyUneR= zp?W_f&J3NDnmLmv;iip;V)K1_aa!z+U1s@M8S6vI(0D!dpnC;X^pv{--^w@!M<*QH zVp-$2nWQ7TT&2IP3a$2CH$`gYwn(=&@w??G7gcOmc zf)MYkCm<g%GEmRG_1puD-`XMV$~4M5xet=@qRWX=6&Z-Xjw zuAw8`R>8)Aode~IHV>4sDizI5S+nZs2TC`8U9&Aq>=&0lEv0oG?btIUVpJ=GSnMTQ zwmXk_mGkj6huFl_xm3YkUPYN5$INPudybTS9Xmqj?G{!SmdkyEFv5W!B%KO~!DhOw z+bzRB%~@wiS2-JX8-G@e|1haQ65V@eL2^K74ErgZfRmNInR45g+#P=FiS5PH#F?Le zCu>%E7vf#=-R#9_27U{HTj2dY5HUA)sZPvnBC%0GyqhM`X0!jur@<$wE6r4oe*U zGP%?#)L`HDJ9pOvvsEvW)Gc(UiLv1g$$SBxokf5nGO3`%HN! zUEeesD+JM|$KFW>NlQM?X^2pK5+}sFa>l3e?=*2lkbQ={uSm4@)32*7FLDc;8qzGf|Z_dK9?E{~AmBw-c3n$f!{8{7u+{(I5 zzW8X!$NRYQnF<~IJnQM>Ak~$XcFNlI1j}ux5cfnf@P#DtF*-1sYx^ z?f|11JughVfS-BMfK4y8oUn~t%k+5rdmC@wpT_rR_H?;1B@W?VUwPoEXw%E22eNqo zF^Y0NyDjrsD{o>Tz4{cK26ZZGif*`@kFl5XM-FWH%Gxmyo{No6#ZB~h*dg0aPbCM@ zc+xRZEC)ob392IDxxhmtqJg0k8z~9Egroo+fvp7Pbp>G}fZcLHReM-Evii-Yt3W)@ zy<#{6gTv?q54)C|G%c^XqMn^^qK-k3qJU!)FxDs_0u^Z8F%^LskkpY!YSV*d#K?cN z;_HZ#>_VGNzfQ)up7HxBBjBeN_T-mE6#pO;)u6!4^#H+$SHrFGP{>9o;v+QWutsQJ zK8&`VIYGcawO4HeDW;w$=7uR-5Lsm82_V{?j~fvV$w`x%4FBepIL{}e!<;@ctXC2# zgXl=N*p}1&8q~U({wcxNx(>_KE0^rV7ym8kJcnZ(=+WHe;d$YamJ{N8A-?eH7onZ$ zy%`^V9zP7xCXc5KvroX+7Lr9w4T{m>pO$3F%Q_Pjb{pZoOi-*Hvy?qoEO6ktuk{|T zQU`74zigq^!W2})6r3{@bpA-w1|~Yi78FvOj<*LPy%juFE4LB{i$L5v8O4aIl14mL zs^mQgiTzL}bKRyR$pPX9bn#SmAX=r&B}OK~GusUZf3oh(?T(Z$P$eL`UNmX6&hZNs z8>6vmPDN$3r8t1aM=C#f!(RT}_@UeTIiQlxr?S|wL@Fzdr@VyCPfsph1Fok4B$d9f z;=_L$g!?43`#ZLqC~g(L%z%&|SIJCut#F__4kgcnTrq^=HKQXgM3Opy9hHmfK)YlQ*Ofv6jcKuDY}mHl1;4A2#LF_t4PDX6Jb zB1x>n=7q^&)!0tsICgN9%YhH7LLlKYDiCe0&1pfF6-LU%4g!;OCc)W%a+*iz8=zX{z==GL4A14ayl|tUO2n*) znj#hIieT9a+~7SjBy6Hs3dN!4s*tQ;16UQWTpOBAQzzH8UNx1sdwJ1%}LEG}K_z>2$0>U-aN=$C*L` zCy#H04M*Co?gkBPPhGw&nez&nb52oyNuEp>HGzx?kr#N;EIQvm2kbaS2d_0^X2N2n z!)}1H($I9p9NSN4!uk*^fr;Lo$$EAQSY6G2=UrQPr{@PCWny0Opa zl~n&}Bgpu_XW!>;col&*+lgCWI7;1hwi1kH(r;hbm55(6k)2FpZ2K*#hQhg<(NJ~G zW?*}({LA#fc3oSPe=Sd7G{avzel!AND2$YlaQh{pZr03TcD<{VVNBMQ{m&~vo=C^# zpSq&nO116Y{LkOYCzamo>%l=)2FlhtN!Ezy)w`1PvX7-!#2I#haf9bcpTKdrvm7LK z9v*1sl-R=V2BZW~^Ntx^M{sFnGb=daXEfsBKQgA0vOE(Nn3N)pD7j}a zIr*#_-QCEL?8Rh)zi~CW-X9H(HfiT09gE)^6ch>ky=mVp-TRx^4J1@@$=Y0m9GiSt zS&%(lO4@f*T@QywS9jLT*Cq2Q$JA^`)Iemy`m)c~sk%3Bf}m&EuFwXrzs$p_6=$St zDhNWWTu#rNvUmZZ24_wh7a_*Ml9(Df5CqUB*D_wW#pmI#vCeM>r?%_P`)&-TB+cg< z5K6N2-lC={ZqD+I;e7L(bB;VIZcTLRd?Od{7K4hUAvN}~0%8W+_ViMQ2Bhr`*cUE9a z0!II7W7(Trap8`-hI++(Rb&sHl6qaqLkqukjFC4Ce|W1C2dzpZho7@)ybG@VX04JJ z?b8d0)fDM8-uc%0U(a{kQB~G;8w(u@)=|k?$F|l{<}y_UPa&q2pvBVpbj=UzUd0^~nv7PF zPbe6zg95V+DP89C9?q;ac3(FJOri+?HuN^``ZG2Xl21}#?2!yEOX80v7;GNB6#baq zn-5({Jlhn7=2J(KZ}nCc-_!NxD69eoW1gnA(o7dbU8ijj*ZR|^rBw@H&O7eetgA&1 zu=rZ){#3oPSC^{}+o1Mivi3U~7+~y8bQdm-_bpl7bPYPk<0s<|J7+T2Zmdpwj+@Ml zhMtb>r|j}>QZ^<4dL<8-xz|O`miH!)E;f(zk34b4xIj}m+lq1QLow7!zux!ngs1t2 zhDrqVWCmE@Ue9m$l!mpxNvWm3&5pMi94Oqb)$CdSL*oDYq2D+FHhb~?mY9KgJ&d+* zaNqgERbh9Ic$rY2b9i9G9bqz9#qK5YkT?~Vi)oZKX)>lpk}52VUhF9NgE`dHm`Qwp zJ6RFBHFva!VRi6z=+I;+KJ^@6_ValD9Dd@bC^TH*`g;bXzVWRdHh59hwX>ah_}z2@ z=i;~tq%xqeq$QqgE(%g-fIyTWHm)_a?>~r4{P8~^HfE=(czcdv39(LllcAe5gS9?t zXJKSh%VJUssq>)=)H|X#H%c_umr@Fb=RnquRM(#Z&>^{Kr8Kkcbm&60e$MaETbSK( zjmcYd)M41Y^!mBu53$RCre&H~ej{7eZbq{xW*|eg8WQ6T^1>R2!I~vNH$H_OJF&t* z@u7F61=g>_rClysv7;c!XN!CkB^G$X1#nVt1p{lyU;DXCFqTM zAUgZM`xGRZYK2?9`td??{ruwe`of3(;YAhbqD1(*MPY88e7}k55BJNR2|#Nv2sEVP ziM`*@V|s-@KN3_p@Ga%k9?NU``gdJb0#W+pgxU&T_;m!vz9=v(iFK@R(UPO6DgQMU z$gC7|yZ?*iyGZE$uG;q@+}Iyj7oiet3Ukd${yEyg>9sx&YI7F`&fpU9VLi5A$PE(& zb;H?|*l)MP*w+Ra`%BX#zuP#LiT^r}k|hNBKUwEKjj?md9A1$X+tK|!jad4@c}}Gm zAo$7&JRCj;!d{dLGAq4#0P^2pJf|=6VPRR&aFqKl0Lt}!Gxa1=?`U_zP!U#R(nx3L zq}kmh);m&IQ8rN*HqYdS0k$$~E?5|BDk@Gf)s&(lF>KD3{Tp%)DsgPHF!8XaCbi+P z?^qI&FzOQS;c02+k}U^|2cLc)e1k(kC*gG{wHS>>BoKDlT8fYXd}cM`^^mlJq!5X? z{Y|)wn9872DUkJmshY`V!|D0@wo)~h&x=Fn5y(?BUnCT~^R*POcBxDnpN`Y$bM11K z0zO;lWk=m=oen-*i}Dl82H1qq=i`#EVXGCLD26YotHB7#VYe+5UBE56n}}#_aMq&f z`#=zvg+nP}%a4&LbW}K#DUYLxI1K6_kb`E$bOwcCL1kTL^*m4+8hP)6wtlu$XEGwp ze)ZV6-WSq~#K2~7y*-|epETb<#A82GuDj}|TIk`nHs`A%z){reHM1$?uFp|CaPfG& zUQztzKsZ#Xaw455i4R$wXl42dofrjGqIDfDUELf#W7nx1UDH4!f&`n!DguCQr>|9_XAu#h zvG<8>o@v;8Po71{zM?^D!c73sDh2bN);eA66vZ}8)(b$F!!&KkQ0&7!V_%W3x5M0M zl5dpTUAdv+JaBzv^rdAzjx@iQe(WpHyu*)OcQ-U-Mu9`94}7Z76j!&J_reXaY02H3 zb&>D3Z8y0@+&er)ISf88cHpVl%#uuonrvM#p=S(pDCK&ddDx%3Gs>^!a70v*h)3hv z^=NPtRA4MzddmhaK40p%F5z{{CbA%=@&wufK0Tw+@+pEOx6TAMvw(FJT8j|O=Z4gH z)hiez>1U?n^n}mTuC$8W0Dzs67X*-{8KpPFaGA+Xl2h#n*vY+L$y5RMO!J=(b~0<* z70e34b8;^uAlr|8r^_QNM%@Kql>|$_*!!%*D&L7kVbw2+erFb5DobVYSqh}7P|ys{ zF=C;V`)w&)68h@9bD>3!jPC%GI>GH^YnNM9 zu>@KZH#?c!9?=gzzh}B1Lb3x3U7_`L423Wj)~X{&l#Gl*{zrh`v8BPWw-UTvZ!QQa zC5hPuWjGo0^i`)l_YBLo1+QxA!M|Q}AM<}H>)5wL>g$Id=BU)0(Nulz2=o&EHY$Hv zeAJ^%J#lWaSEb}@oizKjndHJuO4}ZJNaU9)j%LOFW?MsE*%j|&oZp?C%=)rdOUG3nO(Pu}F|cK$ocA`#=D@R9D?pX&1iaC?7hwr)<6+`<& zpoupzDeSbqkW@RPd+@F?Jlt3n2032A?DNuBlr>B^`~(an@l+D5WITifApGtI;Nvsv7dmyK8rZP3UF|ciGo+FMYCcj29R;B<|Fl`iyWU`j$dF_#o7`C}l)zE!&ULvRxoWhaKth7-9; zwTGk~tCBx^d9dzg@+QvLb{|929DgS=-2Xh7ldlu^h_*dM^eLIZt&SHW3RkGUvZWfo zDPj4(K18L&&>>%0YQ#WUIx=&w!7`MI6zZARHl^8VOnkb^+F_Rxl$c8qK8h;``Md#= z*(b_n(yVzDT-CjBDypt%Ms*prPCB%9ZK(jGUy+}Tj6|KZ27A^Xbsq|H0ug#3__}j0 z)h3ra}|;P7aD@-*-QN33Jo4ezSRD&1nxhBo}O%hd=r!N@GTi;&Mv7SfHf z#^MQn3@W~5Il+@Y9-Q8P4r22a%MMO5O&1+N%vQl#x_$CAoq^W1>JuZWEOot)bY5&? zqcqlxOU};#w90+e_Ly{;JUq$n4KC`(Zjp@ z+aM{E+A_yrCzOWZ7tuC$;GJu|6eXO>zf6hlPtPtKa@i3mp$`>Ehig61wpB zXquUUQ$9r*O~NfT<;yJghI7la;F6Tfnz;Vi=36RKL;a@uHYV~!Wm|k|V~WKplB0&N zq<;;Uqq>4{t6Lnq0Q8>l$MYeBL_$>_LdV1v1*7_Z=FH6k97rUYk|Z{dKUg^ z%;taxXfkA9#azrx-iJ`o^iuC7a(luplkja3UH-bM12RcBopiPQwr)+Q^J}VY&UTdG zIkq*c3^@7qG_4+YUgWy@H%!P1j0DO8+d5m^_1-o;6n9h|L{d`qdWLS@<2+60<2-36 zUP;plUEad|nGP~Cei^yJ?KSlzy~$kY>AwY_G}$Ss4UAWH20{#$VqOc(+=%ho)8C-xi7b$`Kj4vbT6 z@bbzH$D;PM3zy=Fq%WdfX=lX=^uoO~mSp(vZ~!>(}d@F8TK?+*4jNdyVxkWZ4Et7+;X)_(1hdKlMZ7a67>y5k%&7V$ZwNTm%8hLPw{O!%5GXN+K z#k*Qkm``cuuJa;G$Lkc5DmK`4yrV?em6}|4zA|89V9;rEgxD{v0&(-#7V7}cS3~!3g-n*g)&oRYIf8IK_SGWABeLb;BXqO~cmG6A& z1%2i`rKg`c*>89gqHKI9F>mRLSH$LD- zWg(F8UiE$9A@Q$}u+c|1_w|Fzwua}`tJ(-zrZ@E<^!E}_-0?77vk&!G&`+!MC(_pl z-3;v`ph)x*zKoUrX&)BZgl`KFx3DKmO@R}tE7g%+9&<|gh_kPv4fOf~Ih;;Lk zjao=35NK)#Rpw~d+WUmT>daL}sQ5c9tVNjm@LTGr{*DXo&69tMiyVq~e6^N1qzeI^ z>i)|$p*>e?=W+_q7DPc-T} zyexto5|PNS8b_sy^Xi~$FHcw-d^~D(es4_PRE)# zdE9onI0LHgPNi?osc})Ht~Q+Ch=4VPgS8nPaHrOf-azlqeab_2l=FSoF;ggKt!Wxl zw1SW`0zT6UHcTEMKi|Tl+FKmD8Ecg<#?hABseqEF=}6uq zG3Bo}%L%*43ENv&*e?Y8`A6Y5RM2M)*dZYhz6EF!0Gf1!ot*~FJHitF1}&q)2v#N4 z=ttQ1W?1}}KAjsuUTJAg9lRWUALJdMA(`QpT`@HE6&PTjO)LxWxBag~%#lOMbX1LB2^#0?Ow|6&ceWyRk1;uj)M%*qT?zQu z)!GQPMilw%bf|^K-5fPke&(HiOs^QMiG|(Mg?&n}gWH88hM-Yq(6k{eL3)MA3`pqm zzaopI&|pT^?87#akZLn{wA^NogPQZ)u!u6D9;n4v?a6qr;>U)0xpwjHkHo=-DI1C* zJj~TQL?yA&9&DkD*Vh`}Rr^Fr6bN8v_bGOjSa_SARCIeo`9aoB5F*=+i>>QE#_D;IW zMy6Lgy+JXSKi<;D;x4?cL5HqguYTV@^ng8+cs4`hQ)M79N+TX z&+8mb5v!+yLZ(@OF})#6z6oN})vlM-e*+u;^ZdMbYzXaZHt!nq0@XJXg@TT1!fKR? zvjgt=$~Y7XBxQKxk$Q)Q0vQ# zDk_~o*dnd7s6}-~tqm->V?NC_u|?pTBL0<(ZnR7qX5Ws9WDU9EVHSzA3tw*Ztm{B) zp?>T6Cv-9Sk|gVrmCGziDA;K|$W*qD(YvaVK);FjB{eWeJ(xvbVYc-9nLd?(=2cK9 zm@d3gQRTkRkOz_GIg#(nXwf7JvBT%Wu}%R#X34m^I;8$ORFQ7(nU=AO7Qy<8-PsE9 zOAtP|o*=jt4h5_b6hWa9M>Sh%RN130V8sAVwp|132Su{a`Wgqtlh($E8n$mb___4= zKEn+zo>(tkwpXb1t?4%Yjp_45ECuiO?M#N|8e(pymnIw!!=6a(b5TeVm6aLdroA*d zF<2Dll_l@s57Y3a_7#vBb~R1YW&UaVtCtm|Q;3u_=E2&Hfe!KyuGmQe1@Cr)m0OQQ zhVYeq46-uL`-h-oTSl~hj4XJooV|k|M05|W+*!A+z)KulUGYGbEX%51oKjdD7l@r` z$*=~*jWD%bB(<`zaM`0z9b77}Qj^u=ALXV00@J^(p{NY$BbglOE^NYKDT|p={>{QW zoMh4Epv^W=;Ly{Y5{F_iU`$_7Yzgv<2aK($46gULh>_Jxkc|gk4F+FzA3C>EEY(;0 zXNax0e(R}hw0BS=nMh)-Y8Q~d?{E8N6mOE3H%veGXZBms={K0{h6sadOD)JEKIy;+ zWcj__gKRQdClnu{)bAQA&?Q=f0n-hx>1?ZJtJRYn)bw94PrYZ5@ZN9iY(c^zw!S^8 z6z`Tm1ucgf)tLvW(bfvGymz6@7K)I~@Uqlbf|6Bi!GTZMhCP$H~lBMWz19ZK;u0gsE-DDcuc?cY~N1mOx?avQFOSQLufz;a3%X{)7C1 z?E0#FlaOt}7U+GKM}Oh4VfR+jh9qdI7Bqu-14}qOv!Rr01*~+a8*1aPU=;qqfh-s6U9Wb6BsFRYnGeo9dBK7J(sYyIPh-G-E4TZr+OM_a7pYlxdS# zHH5tCe<3Zfm^1dKO9AMuf&GJM^WC*OOCGMRjqmj*=nk>y$??Xsg!>Vi!V@}d#fEvA zrvOJ&mpWe3tg)K`))aL1`IUrrNPZtF@BYdQxxZjh$pG`DZ2rhDy|eGkeDIz>JChJG z+0^e^E^>Y8Xhac(+6CJUk(TUQh7i|Bl8DWeW`jXm&F=MQa2LZ&yx?vZlx@&PtXuTD zWgK<9dS+uqY~P*zr%e6frs1Xu&n)WszS>zX1;uyzy0(a$*%2qlkr0V^c5CS9jV^Te z`wZH_oQvcVhD~C?Hn3>*OW*3bLAE^V8eCtf%zSC|=Y^krib~)g;6dB-8l2{jwW0ng zWldSb*Uq)K84hk8xhkT+B*f3NzP#7Pl?)p~19e5h6&rsF#gn_MuPc%kK zagyh{`mWk&fCYmEO3fe!__6FD-g+eHoSxK^E1OEk@YUjAX>rDD32aX3n9|&nO;3W) z0K@Cl#nTOUBm#5gOjs2q%1h<%E&C#^p;z5p92XSWn_H$A0?<}R0JKMqtgaiQDmnN@ z=Y3N{?wjFz^DFC$3F!E5|Mz0ZjYU;T#>W}Rer_QjZaeDW*w%t*#gnu$WS{PGmWkm@$uagw`;4N#C&|Ad48@pFnUp5_= zXZxx2Y4b+BNA2I^1?#UE>b8lV&E(*=F!JNS90H4q$6uU}$3z96&*zoO%Rumm`F&Fl17-3 zL6JpBk(UR9@juoUgQ&EesI0QI5)%UxTwe!nYHn@A!~$axbz}ARcXV|2{m0s35syPA zh^J@xY|c{JNmxo5KQbjRy2wm; zwd${dnUX5GY^D$&rL0qVSTeaN*|)apML2{A0&HcUa}9VTG%C}?#|YROjZcb2K`@az zV3Za+)fRl%&1TfmL|yFMhNyN2d^W-U(wm(wCqhmSk?z|X)jFg3`V;Wx7t2+U?W#Oc zp^)#d-^)L{n_H!0@UW~pY7c1;lRk5+PtD~^$Ig|Y0{C^PmucivwG_PQ>Tu~*a+v~` z=r(Un)vDAk7;I;B!3WKc3zu@}giR(rf8nm6;MvUXv*T1bO|g;R99%mbt-xYzf` zD!m_a^WTAoq?p89LQiq?ZBe7<5(}XLgLb5NmIkn9hhm%98equ%hrM-0AdS4blT$xXFl8WULvO@ z_g&+nHQ-IxT0Qp5c2h|8zwqEu6NH{g5}yPdFVkL%on|<(1V5Cq97w_~=N*Ki@gZc$ zK-Xs|BM2O2R}?55d#KbIM%FT8#8nNbHAo}JS({0Pw+`dwBT>o|=nDd95?RfvT=l*L zt>YV5Z6{b8IW$ge7@x23Rl1fOKb?J9css%1T>q+EXL%N)@ICvA&+jC(*-9rrkI1*n z(7q(c@if0OA7V#a-??4j(qxKDS|qy>XkR=KYeiQw{Nb3y9)0TtDx2ktujN=)&HGyM z#k^*JuF#BRq3T^8U=S#p=1=iWvSOw<_}}Bt%aG>L`hykdvJ-10yu4|tyim&cb@Pby zfApN#^xEO3z=aQAyg4C04HU4>Vr!MCX}eplw+~^;?LOR4)JqjUN^vvs>_oINy&|Yf zGz&v2ptD%qG6vRM(fP4hr;ZdHsFiR}tv0Ur5fMTSNNSS4Krg_#;;H4}LeoW@0< z<4&&PTI_|HYnn-#+Uefc39>R))}6N5b+Mgf-oyiE=4yco?e_b_!7;Vk^N)t_KR?hu zzAr=3Dt#KTeE&VZz~CyDM(SBNT13ywPjzmZYrk5y4Zf2cwo56AtaZp!S3U1A)t^6i zaUP-VJLq(i5^E?NAK{n~oD2B6(pVRHYF!OtjBA_^o^{KkJ2n-UF-B=wm?xr*dPAP5Q zV%d&Z+E~Do{uo9wgJ1v+9Ykb8$u?S7HDNy)qx_M!pp$uea1a?&SzgMz8gt(f|j*IRsYhN-c1yM;HZj^eAgR*R(>`gcY$ZF+vn zl?5?k*seh{;ln*3++=bohyVG!g+Y?c|15w^EA84pTDFl!;OoOi;SvQV(?T0E z#Gi;!B)j4%e~BFjL#HcV5h_{V-f%)OFQ+%+CYGN+jwJyIbRX5W-`eH8!oPZ=b+Mod z^oAxy_>vNSU$JVUlJkTOpK@de#Hi_(x8t89WScM5wFTzf!wP+jX*Ncxg`D8Qk)qTF ztO3QQ*&Acbq%DCuObpz=UpK$P`3gM_V_jwEY1-iV?TN0iX2gvD#JKcO zp{wB{lbq4wN3+We(jl18Y!8%Xu2I`RBPv23#EhwU`XkWUs!mP%Ewj^Kj7g}vJ3gc4zM4@oCK3aaNf z?BkfPJwif2y4A@kSbo`lAtayrTK01oEv^^8Tp-`Vw%I_FN0_vrX~+>V^74F*WAD1# znj(o6XE0Et|MJM@r%rxmvGqdW!UOR-s>>aB0?(H?p}gMDw8SNOM8Wc3+TMs95)Ob% zx*1#be=gW$?@(|6VYw3=(2DmS0zBy^zsV;NnS#2IFVbXZ-tTQ*0jwR1IpPE#ZvF&@OU8C@387m}CJ&A5jNODx?Q`_7}69qBdqNpS*h7`rah>uCQ#Y-lja%xcm@Ac-FhQs{0`2rgxIOQT-ry`eSvD&`HE*?2Tz z!7#wiYAj7^#%IIpI&BArw|r~U*M`>5^@xS$=$;cfa}`I)XwO$O6pY(5dS{ad8n$c2s)GGJQohwSej-QJqK z+u4pk1_zHMqLXn4p*8lw41)6I<{xq%$mgm)IkJZ_+(8rEL$sDB`lbiZOy@B{T{@VA z36UH4STr@5cyU-{OmYiZ7M;gI|6(Fx`PAPygQ{c$Nq?K-!f4bWM>7coqa%j1+gp7> z_P%{KZ15upY9v}6VQ3!$f8%=Lor&dZRGTO*MeB_^f3P1a5)r5vtz=%Bw z)J~#G&`X)Vpe=QZ?8|?_iZCVi`Epr#m1Svy16SdYfQ1B^*P&h%c!C<5q2|;f-ni$nr zR$_WBk-QjDWcG2!&y!Qm4OJnuUOo!~N=t;H?6FFddZ8QLE+UzsqEW6B>!D>1t|l*} zM*`gQmg*|^fQz*_QX9Xe)vzZEjSGn1k&Kx}7IA<>I7j7IuTwMsNfO%}ccI7dI=l$D zT2$8)(u7*Z)LJxXRRmnFEQY>CqMyZ(3`PngQ5y8j7JE|1(l0SaDl*10@e(F9UNDgCe}=3JGpV;nqh=KQZ50Q zR8z1tf^G?se(M#{j=4@;HCA^U(q{DOWwd(XKz|QubF@J7SQI$w-~O9=5hz;;UQY=q z_73fpbVv{f92CzrTZ6CMnRFKb+Bzu?!@L)rM7zmMcH*c6J_L1Jpcayws$VUH&fEV9-#y86v!sSSR{8?xe(Pb z6jx-l{rO|8Xur;QZ!6`Hx%dZ)@{ywNC9ZAfh_Z=(bpwp&prlSbcVuK$q+fof2T9Ez zX%-(N`ajI!T$^c{74czxW>3}O5h$tvfS#9Df)hR*+$%5@E#n_PcPmfX!bAk{BH~j| z*~(!ZwGd{RGBd4{UlO#!lku|EUC?W%DyqqVg6lm~3m<%d2tLmiYpTcoGc8sR0rzi$ zC$`dH+dzh^*$M^?N|y~Ym(+7k&P!er^3GbzBsME(p?X{FaFta<6IH0Pxn?A;(ovBZ zr8?TDXmlbv#z=k#@}|*JZ4U{NO~^?iZ&E!4*uGO~ZzMo8@9;-EcOSb_dfL@#*m^T7R|fdQcM_1|m;X8)iMW8@5-;Xt)l;!B$=if&e=oIhH z3iRMF{pdqMG_?P#&xPt_9_!GO=+u&&NLWslk0TtA>saT=(wZ|>H~l*!%d0gjIFl(c zQ_Z%%TDXn*J&waEk1db_c2p(pAc{{3A(KYRH|3<+0kvo!>7*Bk}UHXTFU^NIm4M%&nF?`+$4j zliYTll!@I#`Z-wJ7}50Jvl~Y@zvZ&UHNLq-^MvJ z@m`<+@BB!r%YdqwFSWhH7nQ>_4tZ2B0j)w_MWkR}BV|T~5fMjl*=}1k*zLIwtiYUH zhB*3`7(dJ0pLE;~Z0J|7ZAd+?)CY77Gbkxdc8vZh5^QL6z%eP)>AZ}}y_Wt)_0U2B z5d5Vxj^D+zC+FpB)a-Ly!i`+YcC4#~QTzNHj|<-tz@HF&<^KC>BK4v>9gQq4@!Oj- zB=bCixR3ku6?fh%Qzp&inGO+kU4e>keQlp9>eq!vW>b!QqC%!--i!L;!XTlG!a=~u zKdVLY?TXZ|?GKyaVd3e5ml6{jjTtr_(smkF@VC{)fj z9+7Vu1FK$n)BWja{t=e(Qe`jYpGHpi|r6uuLG&RTmJJb{vkiq<<365Mik zmEJOt5G@ahK?fu#07wB$yL%2>olPEdaRj@z>wHlORg*emZDfLl1S(Ts@(Y=a7WF@n zkz%KiH2b(_OYjay!06M`iS3}fG$GaovLjIadIN86LpLcqH5|;eLP|Qqvd)y&hVX!; zQFGzDgsIEzr=LG!F2Sx z?gcV9v+LDx^fg5N`NJ3or-m}n4AVc>f~$9oQdG}cLbuOb0Je*!fVz4popTA@pYn&j zuvQY-A+aRN$`OJ3Ddzbutfva-zy@6CKHXlnq4y}yb35x?Wv~3_AX7z6Cm-y=qDq&s z?{K-A!IGwZ%NK0}%?-Y-e^m)RPZu}9X3Pzh7Z7|a|0rI%c`Nd5{ zC)5JazTNGvT9_Qzgan}a_fR*^yIeCV(RV$=t(RW(Y})#zf(;UUv9whwwnaW+FAcn; z>)iiNoY^0I{n7K-_bDCmtI*TI6=Yls0+|{p4Io+u`r{Iu~ccn{o`zQlCYuDwcGLY6UFm%j1 zfjq>3ptM>Ry6V*ioE=y-3)xx1fb4%BClq4J3o830xI3&(j(uv8C{tb)R39k1E&qQ2 zZ$Oa0JVtBoGabfZ2c>qrdE-j#=Fz*1q}RQtx{{1Jm*h}+YbvbJ#P^Ki z9p!i}rJ?-05?!rLx8A2Lo)|rKK?2{(>%)CU=HC=AkNw8_ePR5R#NNxcYSzS?&Dk)0 z2!hZ7g;2$Zx!`)fnEn>-eS5Hf{>)!I<`XH@79O!79ovbrxKT+2>!FN)PO(o?7Z9T~!u*?A=AFWuRL zpzVi%;0k__dfwn$Oo%)U=%^j&V_rl-Ot{v(Z3{QCioQ<4Q*o1qngpyx8kg@LXX%{w z@1^qZ0FNp%sJ7tc=4i&t`(Z~5e=Dtv>Z#rttIo4K2c1h^W3tX;;qB0R9qS=t-r9-Y zHSC=gt>wTzQ`raKJ)EAZ6lm{~B#DdWMLhG(b8aZTpIOpw0shNyTi^!1?Sa}R2YEw+ zXbB(S0jY1=NguyUfA00&O|?_#4CwNTC)@DO=(?W_@Ko>qlD!?0j%oXyVPfC!p9X3| zL-04==~ZR$|9yKt9;6L#-S|4-#aK}jpIS4K_jbMUx8BJ%7Wf>Wv{jzo-kC{+UD#aS zY)q!uf0LeeQonO$IEx0^^IrMF@9${j-z>NJmP74;pg}<)C^$G+L6Nvv(dbxV(HLnl z2}yZ*VUc;k*~#hgdEqe%I{M*p3i1KM>cRRN0umBSJ8KKj(7>R}+q;|ln=3r*kn4bP z?2x?NP^{dn94$Sa;ZS{TZGD}=-JS999S;8B@L+!a0AbF-@u!|{{;tmMo~{mYkFUSa z-yZ?-FCajG5d;<_STLc&g$pG_a0u~XLVjfQKd`^I92M@Y0afiqgr)p zpg>jwT)P@Lz!mI)v1G?0Fna*OS+xifsC5fBf!w(X6x6+|Ag^8p3-T`b+xIWu1q=We zK1`T_V#OF3V8Aepn6YWlq>(dM4qd!>{roXhI58u|38PE0Tq!g4B1DfKb&zD~5++KU zG->iADtB&DyitAloeCDKS+Zz}uyq{3uVBFk74oGgmk zf?No=Fo&ft&ly8$bks!y&6ZqlM@=@}X`@Ye}ox)KW)Xo0N$w!q_5; zNL@8!jbYvRRgP%!s8)|c3K2x*&oGGRObLwf&+=LpQH=~yKPME2#YOt8^E&XbJ1367l)cqw~tC{~@jce8w zotdCS7o`boMex zE|2K?_+yam(v_r{T(V~-wsG7E$h-B%o5_bJy6B=Tw>-6SS!!!vh2 zd-@%Cqz)}Qn5cfQbbRq0JfG9~Nju96ANelY9kx_oHDt+ zlekIiLv#y@wX}62Z+#0!07y~aWF#)I+^BFn@{zjS!mc5?t8ws(m*k+-B+FF}U-{aX zV}|jI=jn`7muX?a=07{pu697w*zP>$F;9RjP=QjS@KzBECmN4Y$7xw|V%7^PS`m6T`&TThcRlZX zu^ZbHWB162w4|YtY2;fY8)GFy^|5b#SgU8Q?ugI%?GYrwx*vq}_s6yEPoRVZKuw^9 z$N?(Sfc}h3%H1Hztp;+dlH$T7;c`^L9$oM)>~hz;M7ftznsP9yj8eWBhPBR3ESbO|A~vyMwgzLjn*?o!=qF_YYGlA$;wpX_y9x(R8r|gP!#0N8=?gl8#h_A|xS|Ot?8$QqQHJD@QeG*;Y5=vR0uH z%|=MGQ;_)7r@++EYI-%OdM&Au41EpBm}Cj0%>pZ`VvTR<-~ zNCFq~kO?j{wHlkPM>-O+djo)@9}Ve9OM23juC%2ujpQC#AHbhKj z@0QwBr=F~dDyxN*ty*12Ij4Cm-RjL?nMGx^6r5icuc*WUZ1bKsw&2r;_}Z!FHpWp_ z@ueeyo_$BI>9SXR6v>|d=@LK&bdUlLG$AYCXrLfiu?l8rgCELh1_of=>lT2!1K@6V z4?qAnsdtAETO!F~rAC&$ux2;=Nh3iH#89f&lTONuUC^4vu6RgHCZVP<9MU>SPe1grjbw)5rek(GOA z9kyE0sK%MT^=U)5>8$bt@z2zA&P=z6oh@QR((JR3{4LgC{~Sy~GmFrQC3oE#sz61H zJ>4y0H@wd-0C>+^-uAw?LLEF=OO9(S{@!GVJ<353&TB9S$DCrY#DM2b<~p;apu zZ5&s8O%^|dPk$U-A(A|q%nY9J08r$l9yw$pGsTjD6V>6=BFf229(7@T)vRte%iYX1 zIK3QRFpoFbV-}s6AyB&XjxWYddn>c424`o_7k+e}HpBGHXVYXGp#9^v4h>5&M~i6s z3#}H|8T(*HX9WQ4PJ6t+Kkv4?-Rs<%EWam+Q4Oyv-~tb=2mUEnT7)krOR@Z%;p2n! z{9i4Pc;4-f8-EBqbSFk7M4ER*O~phZmw6oLJE^8>&xJCrMtY?eMb%YZBT!|uR%=%j zJ)1H;H-~fKq;p`zb7bao_mF#M#8wAWbZllmW#VSd25mE#S5C)&ct$_f=1&shU)!cE z-llaj0d9sQZq>I)h;}y*22tt8eQ1Yv;YV-c_jU%9EtDj8<>GHSAw*&) zHGhG(T`OdNwkIF$g>(S1e-g(_6u@|n7l6MNTtlWi9M?OYcLC1TWFUZfrABh6W^yI- zfKTQ`(gj6U1#2UadNZ?nH0NCm$0@xgd%s3r!ghNp{-{nc#ECKFdvSyiM>j{eB79v_ zAoBBc`t(=VHZ1)GV6Qk}fd+&a_dhO@NM2`s=7xmmMt0yL6=?TvYsYqNmrzIXEd<~< z`*wbGmwuY%N$mG7N&Vn}9iOv}+(>liLthM|cyP#D z7sp$WH-P6Dh=RyeOyyke=#C1=J4yv8sm6zWs3=f2Rft%Di^z|Ss9hY`RnikMy9Qo4 zH%?)6iRP7wXM|?F=ZSC?EAM5I^Hhq^c29b>SGToaAgO#1b9H6|XmV0mKBgf6;36ZU zlIF%>yO?MT)Qb})lQdbAHfe7-nUgA#j91u`&A4Hm6_g<67xhAoMyYW9;xGSVe@nR@ z?Nw7z^B<|Gc>ec)u3tArV3vfkDFI{C#PynlqhMbmikCtjJTau z_Lei3Wi_`&AP9Q~d6$+5TPGL~n#let;lmF?7m=S>Ch-Juze$SqwJ;iKe7H4r9np~v zV|6{KZGmJVlNp3RW|^3&NC(tli{_axDPd*zZlfuF9g<+j=!+GGBN+B?tqF~JH#zfi zN>M_afG0iI(Ez!*lxWtJ>C=XL6`bSmF$>uvha?(Bb^VOk-R@D^|3Cxr-R zeN_RI5rl>2Vt4C;cOVr~ApSH$MtP0&XB{dEWAmXOFAAfJ$9Tg@CpGE_8mBRx0Hk@? z8}`TwP39_Ae;ac1jqi61Ekg zS(AuLjHYRf-x7Bbw3<4iei#Ie(HK&DM`D(fFSfZ&N!f7TgMT%3kx&_qQ`vaM8F_X{ zY9+@^T-l>h2A1+Dq@(}>4``N7HhNTLde&r3-1)1FSOVUuRof(&kw}msc&rFXd&0J? zUh1V{vWaQ-mlOGW{xWDLa#lyWQfD^CS0DMNIEX_!)|h^VECotX1}cPkT409ubw~K8 zowfefecwl#^=7Zes5jL=vZ6_2s|HaD6Do1IXbJ$Rk&RVfyR@oQnsrXxSdYQk1X4=f|m@gH;|I3 z3^R+YC8(ZUT5QfbQx7MtJ_}!~JBs&tPuaSkzoK8kqO{-|uHrZ$%SWIkX_7%zoa(x+ z4LWuYs(ph>SuzQQ6*`3&+O-;5cO5FJliERUOHzD+7?^sEbBm&!N;EJ;CN2t`{U?y`4u*P)h0@dV>-5550krp_Oz0z zbreIHi2%Hd<)@7WsPEdmUQ3~gy1Y=K6#2T08>%DD$c1bRn6ZjI6=7rOaBo4*8zFC#`|`X0&pqgh_*WwWbV`gH+c~aN0{aB%C}( zr%?Wj!o7Qv!c-?Md}s{Cl6d2w#rrqMJB;;;P*jMo@XC{DtA#$oVIL}#l`5hohP}%LRyUm>I%?0T*2Z^4yysYcF$L9>KYSw~KGoP$Gn0bqz8<|f}C%f`&ZTH-N zA^ga#6Unh?t^|gzmW-0+)}St#eFXi$QRZ5x~LcW`mL{%}-U%P#an zo;oYP`NX42(xu88C%tjQe6hvczAnuu8au0dhzk6@*<^eu&}7Eg8QRqBzde1;B~SvV zEk!{+tPf75Rra|vD^ohzA$oxT{7dd?Ie2VzB)w4SiZqk1bi_hhH zr~O08=*mMA@Xxk5H!SH`ojg%6`PMrblX88bE0W!Tv#+V#BdaXEdo5D1jBwedLfFC4 zXgEH(d{YkV-sJ0B#57#9@h7I%R9bw~*jZHo(10SN*&chp&Uu~DrPDiI&6bPJr=883 zJJiLxLX#MKNS&oNOU_@KvrE&L$VO8#Hr4sp&cipf(WX~+cH$oX9NZKKu3^o1B@CH_ zMajQ4wNq>-%*|lV4Z{N+-3CqFZzHw}O}4(Mny9RW5gom+37Zvdz4n69a(kQCao)Gw zi6A{+A`QjkSkm!*(girUi_1)4j^F$%zs&g?%@yFpV?5E^at8k9DVyL6Ztb{0=eb7I z#!BH~Cb~;~vrWBDekl+h{(|Suy6SVShpC?!(dat3$V&UBlKx95JW%^w)+`a(e?%p!- z>p*6sj-ArOzS5H&=4f0^FpXsEc;;#DzEag{+3DseTiX7=s^F%r;8o_}2FzuzM~QmQ zzrN@XNm-r8Ozs^2Y&^~2qOxh`H?VG>z1{{eIF5#f-?G}E5&B~Wyn(Nc* zv!FO*!H1^BcVDUa?!dj6^?bX;eb115bpaOR!ZhQIu<16=u8GFhWnaA1?c_yH{SwUqL&5=!)5>lu{p>)Z48Q@4@&5fsnYjUj4c!9)8^8e@fd0!y5TFWm zcs9ORKDBqk0k@MoIqKzwYs|-N*~l{jApi&?02dyG9)unriHRSLjUbSaAs~~LA(xmU zA(|qco}D8ip(CWEA|<7$C95R>4Gs;jvaqzZuMW7kxVyL+4!*#@zrY#A#u*RD%E`26Cz5S7?FYoix@9n#K>{uMhYN9iX2&CB!!Y7OIA>MQe_1I z00_vODYHOL0yYce%!yNHPn|%63N2s&{%BF6NQ){Zsx;;R0#BdP?DLu2VWsIm7AmB+z`FH?3l?6#K1ACPA`l*M zQ<6jplkZKJMuZSP$dGYGjvjsB&AU=>-<&pek`4+~DN!R-p~}vx)hxubZ0*v;tGuva z#D*PPUyK>DXws<3mzHf?eEZ+Dc@tL-U4L@^0ho?Dmj%eqW$(N*&w};zV^2Q(_!D73 z15t=jg%1hTP(%!IMp0)TW+bBiMk0O0kx3|?q#{ZzoixEpEu93@O*qxa(~VVCHPnts zS(Vg}Suw>F08v3zV@*5Zv=mcWan+RxUmbuzSbrcO<&;$-aMoIEsRh@Ubk$YXSPRs} zz+Pwm1=wJ0#^UBJ{McdpP9-mQt5 zR~~xj4Wr(A?gjfEe9%loA2!!$qilZs@dqF{0_I6zIt9LiAZGQ@)91GT@MDjk{uCtc zLk2;_P(vMl2x3JflGy$cNba7PVn`^N#L~U^QZVCGHreQ}Pdf$7A7%1oS6hIQOxVe9!U88Ri_Q5!o!@LQma}cG zGtY#78bnc{JgZ3WN{Oztnrf{*8mVlwAyUX~x#c#=slTb}X{Vu5stBo$MDjGMsb;e3 zbf1iZ-F2&E$6a@;)QXs`bEaJg|@WtHXem?8JY*H|SBc4nImBwyBek8O~= zW7faimVXBB8NmkeSPu{f+M`eC1RGGGJ)zpCZ<_TSq*i|guvri3YaCo)J*7?4jj1rP zspw3t6robuB0!LwsyY?4CBBhE(~QTA?U)~P4?Ap3ZbGc}Ywd_AeVXtaY!0ofu^YB!o3ZD*O^ykD7#)-a#o!S1OB?Ft#O) zd8sYP{%ea~I8Y`%_GJMg1B@U^Rz1PQ;!b;fMFx^b77jQ=FL}}9ILuMAws0TYEk3V0Y_0aLnwlQ%W>cUofFIGRIpWI zgH^1|*1;0Y;Dfl*g)&LFs}lNZZYW%a-R9Fm{Oql7;P9KX#xb}X67E2V3#ShkhmU=9 z>v54A7v&DZ5X)gMbDY~*=iEh4D27gSEz0MM@a2*j;pksC3YhD{NXFSAYvTG6)#c--aidqJ+ zflq^A*D}G0R#A0qrXc3o&~{8@=4xfNU}i6zDL1+;g-_1#w{s--<9FJs5sm;&@zm%5MzWPo&DNJU!6lK#O~Wnm0T?Zi?&;mNq+ z(4lc7pvUt~U`&E~E(d)2$&mCEQGb|UcI{Wnu|TRVgz(=VjKfr?ZY`ExnRj@#8+z<=O#i@Kn*QUtuGMl++hRrfWfy3uA!>J1310q<*AQ)SWmbE`=SvuHI8zO)AdG{{ ztnHbXoAR>-Eok3Y!D@rWG-iLzDnjxIn5_hkW(tQD*J{47u6)yvHvaJnVQ=P8%;F5} z;xcT`%;1bd7Bb=y72?i7F_AM(e5^h1X|G|?msv_&X}t8M)4GfVDrsha zpc&oiMzd(FcUz&E@|1IyjRnAa2&N*UyqD5iFBLt@QG}uu0o08ywVG(J)%Svq#;;iS z+g}>^cbRDoIo#NK!UDr}nhKsPga0OKQlG=r6y~cAEqvismotclg>@0xIWBf$4v8d= zXRhs8PZiJ0vM$o+>4ZJwn5eFc&qj8TbyrXyoAK%iWthMk{u=GA6!~`&6<%2^deOH$ zIiukAn8(gU<&u%?+=AgU2g<{k#&o%*FT)c#I3RO%%yi!MZipp0&>2F3vZp0MWOj!- zaMS?2@vuqiA7;Z;JpVyA@#PvNq626Qt~XXy6W}8beX5H8@)Odzub?;1@v_c<1^{52 z$kjUFwrU!#oL-@)k=5WC;`LeGj4)qMoobu^P>9|VVuxeh^I31k*6_Ne%2sxt zNmmpW6*X+9L;cxa^sJ88sBAMLH0#HPokOJ!M`};BOW5v`lhOWUK9*@@eL>T>$I{#0 z%02GFH79q6Tm+~mmsBnD))xIx7WS5adz4d!GF_nl!Dc7%Q`)sC|0Z6l^j($b0UZbe z<@Hpm;%8FjDXW(qp%MuZM{yzm0#T)CT@{0#=WvgvUu4yBuV+>OHhbn#dnH$32gX9w zq;l3|R}OYp+@x21g+nukYN@7b$ESRTwR7bnYd(iW9-=Or10vD~MITXpy~bkM$0FOu zeOeSyot1u4r+%Sjb?3)M-j_Q<)<#}8ZSH3=T2dAn!xjm!ZQ8ax_ID?IQ5GR3i2a9B zun=4+)nx++Gw{Y-mqZTb(_9Hicnfh;oHT(Hm?%CaNAYhf=rTX6yzt z?siOd9NZ0kT#2# zl5nNx94#n8tKx#E=PK60i;y-elU7z9=W($YU_8h&B=;*oC{59TH_cdt*VGN8R%(Hx zgfJ&&JVbL3GFYr8h08~UJeMKuweeLLu-RDJVC=~KI zbyQbI%Z7Du_-tGUF?HB}!DDS?*N2nAF=(d%3E3Bukz0b4Zh!G6hU5Uh#S7^M4aF57 zdM6oUp+o6*J~@?dg2Gdi;WKY`8k1oGW8o-y@fwpSDU$&}mlr^n2TKL?lArQslC=Y(3fE!YH zp;05uMrZHLJv4%#vIm#C1bTOrjZ z80sb>S9iL1SJqfgBbrkZ026b|@u(rUp}3%Xe$$w z;iWW6<5ae|aGGGF!IWRz!C$lZN;ipKUxRT!xq7k!j6|7(uUC{xYK%QtLODql@w1ztZ zpz(T-0?Phuej1oV_H}TCuS#}p4Eh!i8Ycd_cHy>L1KTDl^Bub&smMyH*T@cF$ssva z5f$MX>8PKqK{Ssds**ArvjIRWcwVszgS!}3EqkOTn^l?@HS`sOUj>xI)Imn-dcoM7 zq6>Ry#Y~LRq_>ws%ovr~IYZ3Kok^&$!#5zb%au2Cv|);KuO>N7Yo-vvt=+1oMAtK5 zn2z@1VlQ?@OP96#2~aqeY~%-^S0}IYO15oeuY!uUg}Se8D;ID3N8uK*D1$O}Te_0k zp+eXV-pRKjsu@dUqJ~F?pGvVT`l1;NqwV#onUZKx6}cLuU%&W41Jq}jo3gujt2io@ ztp1>@NgA^bJhR5gp~5<>PFk!vJA_f$v#uKs4+c0k6mv@`t$=lNP*_;IJEmf3h0aG} zTgW+T$r17?FI4-caA_KH8e`1c0qXii&zoaxSap3#y%00D{MbA9`hIDJ(dLnFEyrQ9w!G@pa%Dmi1Y(31i?^;Ge9JcxBmu_^g{z;}} z`r4rUIv3wdq2e3G1PdOyz!-QtO|jco4C}rnIwRvr?)zQt5kDd6icg zw9vYx7Un}=%4$J$!q>{Q>AAuzoTj?Arag0xZh0thx)N6l#;BZG`DkPQ`KRT#r(s*K z2_?&1p;}=#sCcNv-K)!qI-!s$w}m0akm@$VT*XtFT-SKano**fD!Al2r$R%&jzY%v zd&U7|lNG0EFxkee3c%+qz;bMQB-mA*Vw{dPxq8fBe4NgHTmv-#!Mbw(zIA5|@0^U) zxw?o9Y8y;yR>{vYmqX!6b6whMNh_x3S*Dr{biw<{p3~5xOrP|Eyr%3DSDUpuyq~M= z!}QpOU)#~lb^x(luU?^AR&s}Uc*{%NuWA>!j0(jU3aM*D#Rp5w`y6kI)3EP5D25Um z^+K0oTr`l9xV0h8m>0)=#(Bcg#$eU50Zf#$Sj`^GXm&i#xazX#tj@2u)ieOef~*)} zUBN+!!PTU}Rr)ujMvYl|jcuJcH5UOIFwjF3*OzS2DvZ!tc$V+!g;V>`Vwk+iOVJe# zs{X{oth~|osMsEzFa|0y*;~@v%eEcky(#@snJuu?Q@6Zeun7K3seRYC$qcbQBflz2 zzm3w`NMpu`Z~+|KvGe5{Y%EOLyueG{&4@O~rx(?{_$qm<$HpX#p_|pm?VP3ytT7GN zH(Q;@igI+7$W@xp&Z>m{>{qs{4%=+pBMQPkyy#egZ3mgip z!KxlHEzD1P!8`lh_spz1zE{<4AVa&ih|{I+u-!qv-Tq3ujVGMKbnUcgnwFj8IczDz zD+bXuEamJi*h1sp7aiYwX;AjKq!2z zN*=W^EUu$`ynubKD?jD#sLEWc(bB8ziyhKke!Y)<#8*P7Ys=p!4ZaZyuyX6mYR)#9 z4)Gow?(K`r4{PT?)66WIxMX|?3REf6jN!T2{wY(H%{7=Ezc`dK3wx-#DqoX&_N8%V zV}p;5q+vh01%KRHjojRh>4QuR!rbW&5AmUH&r|ujZ+@lgi}4{E$=ZTA9FM!Po^!Mw z-nRaE)S~2ey9H_-(b7tTfyx1ZSx`x<_dbt{N3LXT3cs6^es&o zwn83kez0yX-2&2Aaz5^tlhZoQPk8Rrj$*%)a>f^4)JFZWwmk}yd+)Bd&Q2Z9$IpwM z>*(eTv%=V%yh`bDFZZ$!T= zmdsbzjZcnvjbb|O#n$)amlfrJFi|o7NLXmtVOU{72mny<2pK795J_1;iFv7MfXR8u z2^uO2dSFm`Pzr!*dWwpQfN%gSn}ASjn~+z>78 z;LuS0K#lG2z}@`-@eLs!Ar28iehwiKvCb~>4nH9=K|euJPjRnLQIX%DIB1bT3l=UA zynwJE!V4Z4dUy!Y0|e+7cxKO>NwXFWYu0RL z)y}0G*xca8kmcF`{Cagi+=&P(I!KU03k`@6L=I6j(M1Ykl#@;(g%DDNB?)y>N-MSW z(o#&(bW?*Jbrd0l5c+h|gd`EQ5>iIBq@heS%{0?fQBg&sRa}7;RyH|yQx-R5wFe|x z5U@q$kaLBDWL-+$RsIfMees13U{MxEC1O?{78sU~vBM=i^gSk-WnyB+S(%)Dh9*6x ztw|bdZMJC-Yx%jh-)pwvR@*;#>c;18y#Xg&aF%GYNukGuf}C=qoDy9sj7~?LEU?r< zX?EKA!X0?V6oX87wdZo6kvc03CPfa z2R@V_Mi*_A5k?(7_!EgisdN;J8N$?5O&#L&p@<xH0|>nkjhS5!2~-pO$ytsMIuIDtoBvi`T#efBEV>^T?`ZoVCsdkbk)v z#4CXXMg%N^3o_{8P9c^!p@k|wE7OM3J}9DyAO2JlP$ilqcZx^RU{u{pz3Ae&<(f+s zx?JUW
OGx=EYdLv|!MJAafzDs_ts*?djIk44L8iqQSs3+Xzmsmp_vBa{6M)7EB zqK5mL8Qa5g$FO+}+dm--pJ&No6T%yyEl=_Y%$sylbIp%V4;`e`{cKD2*k$L-cHIr5 z=`qRvkjFGMqF#kw1~~?GtC6Bo~r$t^)GfP(%kND3M_eOCxM^(Ay{k zIA*QrSun91P0&RxWP!w5KG9Z%6ganU9Zp>1ipt^|R|6a2NOEGCTv&Jnq^ZfvUYzrs zT-wL4C&|!sQ###W3Pz=au}(1xYZ#cugqVlTPBRq4PiHRnCXB&pHM8f|mXR zA7~Sg?5$ea(qtx4ltGseZj~@XTn9gRt{ONFEAFc0skkw@9$`)`^U@r>j^sJeRV{Q) z8b_4=?DXi4FYV%>(j~lbHzn$ zk$Em_o}r#+95F^OXRTg0fayI`}L)j(*8ODZ9hV6sLsqLE~BTY^Ih zi@=q*Xg!5o8(^Hd(3OFp@)1WRENbO$$;)nJ&PYuCW9R-TOky6>p#f9oL;h{3!-M&7 zs}T!g5UDxDBHB(gxyzmIdgo1$fhz zTCmZLM2q7bzmqgO-jM+qK+iM~3N>}H?}f&sQV-)nNJH9Vv-!Cdt_o7Ng*4=B{YzW0 zEHXfmlG0idiW|31+Q7PTkfkmC2nb#((~`oCS%UM{DoY?+oH}K3AMB}d)1|&zo)D== zO(9yoQ6wWpS6`HkY7C`{%&Er5s#rQ$R(A-|ExC#^UajWruF1P>YLhihOsoCAsV9*U zLY!{(6BbdXMY^(+PSZm@$N{tV#=OL)Q*uCRqK zjNuGxc*7j-u!lbk;t-2?#32?`JH0rwyXG}#%Q0g;pL2p3%Xr2#u5pY}Z~`2oV8=Y} zF^^M#0w4!D1w<~gkyVfaBr913Om4E1pA6*{tbhe7V1bmWY-JW`dCOexGM8Jx0x*Yp z%q=Lhna^Bi7pQs7Y;N(DL8os3YEOF_2c#~wsY#s!9OPittZucd zb&vyC=U@l3X7vteed}4@de^+>wGMWmgJAPO*g6=tv5SrVY#u0k+01VCvU{NH9!PuI zJ@7%bukC|uYkS+=*7gs4@a=Gm`v>F(g1OIa?jQg`-9cctyW0)#c*}ds-|_VU%hHt!+O`T?zQQI{p-}L9`&d{cCnr9Y-r0K+CJbx z?Qd^;YD>G@yx%st!42-;lY98YN4N2hukLlH8{W!i_qyl3?|Se1-~9IXzwd4E>?eHT z2=BhazaMdl6QSZ1&-ld6uW^oJ{No)bx%*2F|C6hH{`9Z^{Ex83F23_nc)dA*TP$FW z0%Jf&fI_EZJeFff7i0^VbW5jnP8W4cCUs1<0#{doO-6MYIAv7VbseZ>VE2J!#sX$X zc4n4#C-`P_H+OPpXL<%_cV~BYhj)Dkc>aDjXnUTXfa>|jOl1UIE0Ytjz&nCm6vIihk2alg!)KoP-tqd zwrcR(htVkYG553`vH=_IePhY!W$pYq)#4_lDKBk#ksw;ud@)8ImGd zl7D!TDJgH$=WoeLeaLxl?S_Z~Cvc5;a6&)?)Cq|>*>KnyaYZnGmWYWyX^G((oi7G0?0F1X^UD(W4Ty#ytre)D3-w}j8RvNXIX*A zXmxD4fml{$a4DD3Sc2B5W)iA)Y^P?~sEu^@g57v`;D~pHd6zo>eT!I~G+CWC8HtoQer?*O z8TXUu*KwZsiSK8WD2Jz{sFd`F1S!|2?fI1M1T%*cMk`j8Wb`Ps=nDC%pEpKyUHPBB zm;xtIWDMwlPG^=97-eaBpq;9WT9;*Txn&PZW)W(FYlfG3>2_}C0x)o)E4YGl=Bj`R zgC2@^gXed-8lvZ@n2BbhziOh8$#|5uqLRmiFp8}Cn2)9AnKW9XpoycnMvw<7dSck4 zV2FA@`u?L0d2Gg3q!y`$v!{C*sgb+sk##td=?a`wdZi_qrN-H%Vfv+Bs&Ce(ob~#g zi%6aLmVFDyaNnn$+WBzYNq*xQp5O_TKv|yecb<8wo_pGqed=;7C$adaUp5Cupb(2= zbd@jG3boj%GRB|%d2~TWsRDYb!>FlJcc7fApv%~d4my`&SC?o;jT3sas`_?(d7&&A ztK3Md-)O73if4ldcsH1XBTAx&ccM)@X~HUL@aT?Hdudghtee@aQRr%_=4zfNkko3L zz2>6{xscl0dd0S_XB(SnD3KJ2q~toTP3ojkimp;>rBrIA!>N*e_-=kkukzZQg;`uo_3Fb!wiWn4YD0ihIhGOewLzQ5>$AvGfUmRym72 z_pv$?vW}{YLnmaD+JIq+vMI0vO_!<0$f+*NmRYu-qB^tCXsT(JvuX!-tjcz-ilKkm zsxLUJLTjshhpQoqn7rz%g$AsQ>6pWsY3&GV+H0)I8l%f9qo2uYT-$11E3G*Swx_w8 zt2d-S+O6LTu1RW}x_6s#Xs*0zxA{Agc#EZbi<19Ki1ZqL_Bx1z3zPh&uQUm;;K#s> z+qjolu;;3`gwrfF#wx@ZmKFYqWr>)9nhDF-8Y&gI4tDADmd%Y>8 z9jUJ0W^U_ReC@i2@7lNOW^Y{@Z_F9MFR6$LtiT0V1lO69;P=3f+mi~Lu;qEDcbdT} zR|FdDo*hiFPU#4Ps$!vQsCt#CDNH@7dw`JopE0a-GJIshNW*7&yEpu@p&GM1+`BdV z!@;YwL%eo!XS{TV#KX+ILo1HXOO8*BgHasCKj@g(`^?xIc~$G8-uwQ&oQciO8k*4h zdD2>~1^I=r7KXnjq_2s#@B6K_=f-fnd*yn+P>RQOOp@t(w|S_y@2aKm_NB?m&w?wa zgbSUC{D?T|z&Z)RkBfd3Ov#pv!Sc7Bd&!%BqjxE576Vtf4oMq({cPCeFbohUKibug9&j*~aqA&TqJz zbiBX7r>^vDw^i!a_w2uZC~xZ)$O9aG0c^lBnTRu4la5Gmi~j7$2)D=v4aw#=!3j;t zcFM30t;rqC$&cN+pDd`)b8{Fyx`=8|rpq(a;n4+XbR^A-FC4qCOqM7e%TIR0xT~O{ z`qH@E!@rAmsoKk{%9m>w%zycUNX((eY?$I`v_-wl>4=Vtrqq!Z&5-AKE&9|@{e)jk z)m__#SDn@2%+;!wwq+Qk!Un(UOxElShjMJLXg#IFH_!E~hwd8J`Mjld&5~l8*ZlW?Xc*nl$*=RF=qrI?70@LVxlWxri{XA z)Y)6vpCWCkpgr1{TDvI#aX^m0&9bwM!wb5@u05ABJ=4{Ag8nznsu(I~fO%(2yxSgH zgGXDm(L17znRrwztXC|}$z9FMEu&DFwP0M;IhxhfYR0jqdR}d8?yJV>e54gw)@D7o zb!+7yxz>3L*TwnA&&S@%d9UvclZ`mv{p#1>x5#Op-}+tH{GHI5JaGa3af)rZjIGHC z?!gES!VBIA7oB3Tm{*6o9HsoR)5F<~3eupx%A@^&!>F=X=iz9X+9AHXyxYUNJdM;S z+iy0!I9=PVy3@-Wm_zHtK~2<%nV8m_c*YH^JwDApZp~fX+?m&EX7&9PW{wf?8UTR>qYL(Ryf@VInJ!Ntxf*qYsCyCC}p~U(GLiwNRbSo7eKtjqB-~zTsT9ubIZ~n{3?v=~#>*?;Oi05NZu^x;B zeJ-CQjP|s6pQg+2hwj+J69?LkBE^FsFbLqbFQ`uh9-Lx}tn7%-qf zA_xs4EHb2s!-o(f7U|%SVuyU20&d(*sPQN}YNDz=^9^v!d8~VyjmaDNckP zo1(1Qvu0JKP|LQhinl6Oq*wu$uHCpR^6K5oVntsTfCCE-+=4~n!-fsFSj@O_3l}aP zKZZ;h@{1NPE^Bu2g0trrF#cS?$eek!X&9(MqmJ={bqpA2;YS(O&jWytaBMvzTrc(}rLIBZVgXpl+&O7(8Q%{BY zWatk-03B4&K?s2uVnYsvC{aZdp=eP?7I75PM=*L+(nT|x6jDkgt+WzMGr1JgOf>;{ zgib>ZWz>;KCgoI9OhVPvQ%_PQWmQ>e#T8d6fF%}MTz0uuT5qid*O+<5r2-3P+O^l3 zeziH+n}8uE=V6X9{uWtflT~IJW|(c(8EKq#78+@#foAAwt%2qmY^~MS=xx637AbGP z=~i5&xhbb9afUb--KUXA_sAsHO_#$Br*1-tC)<6pNq3`|A|83=ou}Tdy3hg(e7yW} zOEAL-Q(t}iG2mTN8% zCq}elix|16QH&pvBrlHi>d2ChJjSFiO*b83lTJVhC9qFPCZ*KDPA(}`lv7G+6;>#8 zCGnMCjV0EWUY^C4m|u=L=3H~tg%_KAxe4cBawbM+osB^znVytsrWt0ReHPkihmwX` zYCEU)8f>fn$@VCuxJgRsq?Zn7LvqJ0y{V_4LML@2i$Fr1b(EmG398v$=V~b5$trd# zv(jpcdAO#B%i6s5Dqpa}7K7j1#TI+4vex|9?10aDv*0=E1TKy}4i^5-gz(6tc!k{d z^X-NMeYlUg3Y}ZTLMN`9Vn!^wOJlq;f}Z1zGTLh|kEjdTuT1~$6qJz##~zi!3n$$0 z?Nm749a(YN}^ouG9BB*Y_!Tua%9ZCO`0HCTm@rh8p3Ou9; zkJlW>W!$YA(O8z=_LhyljYC?1o0fwTcQ|{* zBOi*JM?U)DxNmhRav$>0xptVYhfpL%9O<0rWRxS&*~laxsh5uOl{$R=NJut80>B7H zFxV9gDF^#WRGRdZ+2IZcLEAeEL((Km)$;nMO6I>Dg=+c|M}8kA3W0+HhoWgG?bOew}KLBcfx!Nazm- ze+cFNu)~2rWWto%`I;!eBZ>s(fPrS)!3O?dD_iN{4>~C2t=hvj3ld{K!W!1x^8V97 z{v-=PBix%dOo$*9CWu<@FkIr|;X)Zs2tyl!9ET>yO%d(Ta_L$T5Xb2`cZuXhM=Txb zOt(ZQ$^>7kW1YYJ)wLiAP32rn}v@wtl=3+fd;gbI#PYSY3Xl-b16y2G=B5T60m46NpDtIFht3BRhKbEJcC5;6yc z%6e8A($I0*#9=q#`b~3P4s$9ZC+99ggu7~_Ml@Qdg4ua5CZ-OG^NgYtU6 zHu5&OU7w{^I!UMHrjnPGX>f;Y(@|M1r`S0qbN_$|4iHd({DUq7H=sXQa+!bDZK_gd zAwga84}!Vi01x)Zi!-bFS88T62avJ9V-(Z8Av`ZvySmSg~8AUBdj?uz*6v z!vsa6K{1BLvn15Sa5*uVI@{Ti(PfUzGg*sAd(l0f7G`_WUX5*5$k&c^$FlLU41R2z z+~T%3?Q`i%f2-vB4fm$hDWy-N{L@lyqPaO(t|+a%N-X}b+Z2BgH!a1(itDn1f@Ws( zx^+=XaoYTCq_6F(N*BYwpvqfKRQED`!^(HvGEsoiNs~q8i+sRpTyCtxbZYuXb-R5R@ z98d~-hj&z#OSJTNs{nXQl^$jmO1xA`YX*V5z<9+lfs6MCzwmf}5P7APaK_{x$b??a z;&6S#UVk<%?=@)HLJy0>I5UK3HpFoaF)oi5S9SGzCigDvGJCZ*FDTJ+E|+^TH&`?0 zd%p)Trgl$_wR5W0b3XTK$!A&2M_JJ4{v{i;Mh%rFc+rIsrF~8}THVJ-Q-^Hf2S``f zJvXLx<0D(p#z@mvZABAgyVX9)F@N-j2%4mJ_eU!KGj8N|9dbu^ZpJ_JW^Sy|f8Vip z3ix+Og)0wOc>KnA64(np;AR>)fyS_A9DpAOcU23QXUx)YUgc+k189cxAS_rRFNjSQ zQhGC}UkuSrs@Gqv*F!4edOcW9v?mgMl_P%jR}S_gp$1_zmxMcUb6B)kIJZw-#6=s1 zd;q0<&DVUkMq zz;TCps7c=@Dt`Ef{zFRa7JzjA7fJ#-kfv~Vi+F&0r&JHrRJRg|g|~PZxC@VGi1EgF z9GDEtrEVbTK?^sE0%C&Cav*;*k`f1B)8s;C)ryRBUo?0_HRxy{2VfHML*ld%Ky+!F zR(ndsU@sR~y4No=_j^J)MZwpEItL|C=yS-|VUblvRcJ9J_9a?4eInD1DYkTIvVBiC zhEj(o=161csD@dWV}}%5JGOp9BZomIWbyYt^_XPw!w6ARQ+;?f`4@eW4ud02CrMWB zuq}`HkDhedEYS<%n$Ocy-K%GwaA2=tn;2la`M3 zNOkBNNwaOqVUP7EKf_gA`e>K=2SEN9O8@tN%e6|mgbIkbmx8%~ub@kih)Znd9?KPx zjYok4mx+)mUYDqmAZT8g$v1sAlBd|2Cb^0zsgf&c52cq@Eg3Ehk$S7wdIH8SLNr9P zd3!9H5-o9?FZYwXcZ5P&qrZtyP56vXn3PJ{qp(&nTGE_cl7(#nom?oLD%K`>5r)yj zm3C5w+6k6v`2JBiHa?|smb7s`)Mjn%Cw9ZZTiZq)$zcfYSwCwRpZn-PJQYCVwwG=S zfZhRsxMYA}6POHGORgZG4M~Y?_HX`HiNU~T0|$8*iIJa3d7)@|6Y4Cb2ytQMnJh$B z9I95Yc$(qjRxw#Fw>Xn1vN@XLgPEq2o5qvFD5Eh^SP{mXIN_VVNtCC?jQezys}_wu z+M`YRJ3<S#!bVwNOzQq%@1Tv{nB5>F7qWlF;xLA`scycRBo59#l zJ=sLOm#Q|31WDj~t|~jiNjr|!bH?dvOF4}dV-{C9q(--^TX>}2_>FcHj$(M7FJnDl ziH4scmLO%NA{CyBL>uI(mgecDz+tWRn61pQt(-)c-724OXB`7+pPo>zR8|UE3pU;{ zZ+|zK0@(`QksetqkhZ{hx5NWkTY&t+uOXOcq6o0cq?wurO@ekU zkqUY%NvVtzF8bvm1u>#AxvA>nsg;(Z9MOxKHabV3u{+WMFX|GUo4Kmm2`@KXfTy_>+j-|_y$ae6l1 zs|teGfV(7#4{1Tc@;2%lOb&V#wxd@z-x5vN_{1Offx}hthG8bXJc?1`{s*Ievu*$lr*1^z-J1Z-N zA1qMH8MDqwJjK(ixSOO)3XZ(XeZG5aQ7XL2+FH%VtjF7qjH1J9$+VHOG)?ogOM_%V z99;NVwbq+8Nt_9);x&F5r$ZG>;p=yJO1`p?#ajF;!U9bA!9n|Kh~)LJB>0i@TOcC& zOwR;OEXYFlpg8r_q4@xd{@Z9Zc*nLlz%<#%pqgMQXL}3mq73Z0LjF?7hfG)?`+M`` zo2zQNsGE#QVw5ObJ3N}n9TvhaJHlK7eI{(X4He3w+!woB%1z3%G4``E%sn(rmgkp9 z&l;^@CuET{NpFeEm^43A`<`fO#HA9C|$9Y{-L* z&#Lpe#aO|M4A7>_$c&u9tGkRjw{yfB@=Hj!Tn>9@|Z&CsI8?o~M9tf6nbzx{yDA-Z1-!Oj9)v6U9q=k&)K zI}({|&!BsoXDt)eEm-^*A62!lm6@ow-P9l1sJtCG@zutk_k!h2sfb409Va<< z9KeuPSDG_myU2?P{EH22$Y_nvYpt6=iG(A|-2u)1$Vt%Tt~%EU9>BeJlQN&*#~Z9y8JYIcz6F zh?Z#Q{ILJK&J*ij?wpGk8_x&~go3=eW^Lp{p2#%1-6AWpaqZns4&Kc;s~VQFDr@Bc z#n8gO*OwL1?(M5cs>1T!bZ@ei8hziX1+*T$-!+^wH~imO>Ke4Q7fqIYPchhHDcaarAH$jw7~9AJEmv8%3fv>Dw(SjZ7f^Qik+-$ zt~1Swyz2+&(#q}g*fidbhvB}`Q?uFU9toeF9m&NBMm2Z-w*!3HwMSK5u3*~thD!`c zLAgLd{NCt^x0pUa_aZ*clh+IfFPVsH#<)$P1H0lXwCODbdN6KZq?h<~{J%Gz@usfa zuo>3#oRcE25@jvqoonPk5^AJt6aL-3+nWRcU|?`STzqV-jC`Qn%-kF;EsbzceQlkM zjd0Cv4UiHpKAxgd9&Vnl{<6-_zM}FT55GcRZ%@y%lHanz@87SF1&bB}2^t*OBB8>C zEnK*0*wCRwhc8;ZsEE<7ZMENpCo1>NKiU95<+1y?P@D4jfu@c+J|?>xMr$cI4nd zc8A#=Xv?a7`*wqlKRa~T)ls+Z-5osG{?XBwhh4!sdK9*6*f0+sJ|I$dY~Z zu5@z? zokUZTHu1!yO-}Y?LkvF=MU+uDAcYiDT59=JQ&N3tRaI4CrPWqjd4(odVzp%!n;evd z7F!$43721LaeybDdfCN6U}z1NXP<=e5a?k&5c)@CeM;6?pgla=7@>J)7AOaq{m>a{ zqLt=@rm6mYs@iL!+D2+^w8bWbZmIT09B;xAcU*9?&PpqD(cOBTb=Ga?U9W|NH(s!g zm`7|U#-gWQd+g1}EGePDhhKfL+?O9M0OEo~618ND%Pj)_QXn(pDp-s&%QT3tHtKF; zO*a%?h~YWr$jhOJAi^`xi1wVAB8n)k$f7|nGUO0MG)jaKMizC{QI8{yRMJTv5t-6U zFUgeTO-(l0Q%_Ry}pm||W<=9y~d0M^Spj764LZjzN}4uAZCCk|?D z5GS5H^ZeIcj_L5Hq&wsJn9w};d1zyaBC04_OIvzbo>yl^^v;z2kr`>6f=V`Ptc~iL zss6Unwl=D3vkDxn#m#Nptja0JoUOQ8S6$z`YDZnK-2n^Uu#6OoII`)@=gBARy~nI7 ztw}?>+eh zMB+XGtw<0HF0?qXLNQ7-BaI4Qv~Z3W?FbS`LQXFv#T8$iamG$E$XoiI*n{cM}r_(y*fHVhp?(CPp)P)0gL0ZxBXSKyJ&1njR z8loiQ7^hVREswGq*nH3#3|=ra7z9nHIH;-8lTw+8=tBx5PA(Oeg9R;S0igeAOBSH}R)9Pw zx^tCILDN7Tx*n8`b*<}l72-zh#4$U0)y{Uf%UAAt=dXVGBVYmR(>$QZxhdDN$Af%wm?dv&ZltmsHar1|6drJXt1#Un`~uHRwUo ztY(C&Ia>*1Q>wM0&}}Ph)oxDHxwM<64Ar{@~E>|iYsCf z8|R6~Ju7naSt7NVSS`%;r$3tuQ0E9#MPX?1TwEk*>ZY+eZM3e8t}|o2G*mC!xdUGz zdLxN=$FJW7tRF2J-a`gB>TqXNuYMcOrv}mnr4=k`>`@kbwZ2K@X|j#6>ye-$=}p;NwvpF1~QJJTBQO7 zHe&j6tQ^eL2Svk75|;3UYCDx~bc35#S#xgJjFoa?xJ?>LN1WpXTp`S9h#fLQSc3&( zB`$&3^u)7S^c+QF>m#iuIuUca(3WNU6oMVh>cloUsRbl4z)1k;uh$znx{DI+)5F`d{ne3Yytmw0-z zO!~BwSm8?iLg^KwmW7mbS<9bJdCEHZ#cHptR002Fz^r1mtA|<)qdN0I3l42)WF2c~ zHf2^%F>^I*jb;i@Ma{Tg(>E`~Cav)1&2HX`JGrW1Uvc=Ia~8I+hBZ$+7wgUpGd78i zO~pO&nNR*a@fO?SoE1F>x^N8?v|Su67$3yCZlJb|sa35+TT4+l=5BWaf#W}b$5Dm2 zXm|umUTzWQN8ak_c@A4?NUC>8M8*`kHSyj~KxP!?PX3Z9J9P?lF$v~Py6=7Qv#xfv zdsO@Rg?~ZoE?k^S7pT@{Xy{F^EW5hit1`;Hz>J`!Fmst;ZqU9L6b)KN)2Xzob*<1e zRSMr)P2RYQuGvJ+U1O-%y)wA3Qt}VJ|J%OtNBA>5=XJt;QE}ml#s;) zl}ofP{xSVk?9M1v9DPt zbs9T#Ug$8ky^yVAeJwkV|EewVq}>qVk-hAFympR!t8IxHl48WQSoY-3G0AmqcDH4f z)Fodw6`1r>R1t4vc3tvgZ%4&H+ch(9vPx}XK;s2gM3WbNQ7JnED2YOOlEOd@RDv3$ zC}5K{8(2&e_e+)n8Wxv&WwUx6CruxhDw3vybyaEFWP8g|do+}Ce#2ll^jF^Ta>6%r z#Ftn%cYKVqe2f)^J2yG^;d7TmMc5*Axj=oLV|~`wSq23S1=VY%=J+^*c=OTAhJjnhNQo5C7CbeWdqIT2sWIob%iS%u8w=vzLh*u^hjYu*h zlWt0Z6kVc8eK!>=6L<_rZ$&jqqqG)lwn}tS7TrY`^Cdt66c{^Tih}`5wscjyG&GCR zUh_2>lA(D%@CT661E#nc8w47KMqfa1Xo#j?pHhQ1m>Vh-S35X+Jy?5~hI_eJguGWy zhVXlZqlBZjgzVIWHD`0lazxB0j?On(nZr-pB5Nk*g+ZC zW-!x$Fm&&W;Dc$I=cjeeCw)<`&xpoHrLmZi2>@B|8?Acc_?S>$** zLFXTB=}*-Mm$xQREGCcLH;)RHhI&~c3BZQy5Dsp5Y`F7}To;f*Mq2`NTewAk)~1m6 zmu(NTZ4YUP#)T6B*fEi0ZWtMfmc(w;6`Ep_iG#<9^J9{xv;#ilU2cYNZsD4*v?qK4 z7%mDJF>0H)DT|PSlax(J+s7MwvDLWX8~iFTB&VK&Lhl*zc9D>Pui(SrmgLqWJV zo91AD<9mYB0oRC)!^ec(XmdoAeB=qH@j-=XX*su`AJI2OY1*Ee^`4%i1aF!}+DC?| zV}_^xMIm{KpZLh1?4XZ01|t86Q2^O>8znFVd0S(rJPSiofAohbC5S;nh*1WSl$nU* z<~`@8Wt+Jrd&iNNIA)(jcoFD{sac|Vp^A0FKP=i8E_oL)$%-^dqq?+JH|k!sxT8GT zqneR%#2G>ucN(Ziq@luSY;}XR;griLa+F4Lw#QA$L7m}boh&D<+4)z%XE@qeVc@wq zUg{o?!(n1NrfCU9Py}nU=9cT&rbz&&01#U92_f%Vr+A8=2#^5uijNzzA^v$gaTuTj zDv<7HTLq~{)P^H|1U(GOkPfPUk;xL1dWbV|Ton2wkW>`rhIdwiK2U)&97<-GIGX-L z)fFVEU2B1oW#KaHg2S!|lFD7LP=Hm3&_uTU3t^O~P#w5NRPhVL*@e;Sx2GMIx}n1yPfc{pte zx~PBzJv|bLj|rhK0e2EfWsO8`T2>_ms1%v&W$EKn9U4DQ@v%fTKO|YQq^hDPDPH`8 z7iy7;P}Q<8`?4}RvszWFQKOr+xRaN`qdkgfXB9T6hm^z^tVY^aDx@mR3H~>-=R(3^ zH+B<^Qpz1!>3fB6r8$HM+!<<2sI6iNPw&yKtnfH!*=omt7tFCe>pLJQM z_F1=fORwBeulMR9eHw@9HzMoDYy%mv1$mHsxIBvLJdVjy5F;^d=XMc_h?ARKbr(tE zqp2FXp&Yw1VKSOG5W3jai6py9rK+N*tCFd@x*a&1F&ewCI=ea9UVBywp>VbMu%cxtgd71rg16_+=ozh`D+U$zv5S~_S#zb{tKXg8>j+mhqi@> zFM^I&oV8dPn6b0H8$v#-DXyFvM0$*lR;aYG=xQNNe4KcuH=a>!3Qv2sp{`auqCb1PcJ{F6)jJ&ZM z3&~?9CK>#(9NfXFiL$6`s+-KJcJax90jo25o9%_sxckEXn*p3NOv9G~yuaES!JETF zi;QgpX~+tdL5v)=Qp8p{gh(8%+RIb-WNT|e<$M6?YdDO=!^~Y)_NP^6N zlPRH-OLq}$cNd$nO<^*f>$#vhnt5Hx6o`^1`-!Of*KhHfQ}v=T8Onn(%C%a`Ig6vJ zoU5$NtDG{@lg(cnN3V##Met$Te`jB+04)! zzR+9>Ryel!vBhk;wkM|BW6aHO>f7--pWYYFo7MW5Y&*uz{R^<~3{ttZ zJS62u&7&iXd%*Y1uq)Aj`#g~ndzl1ycLi8Jp4q9M8p)re!Rw8hrHi^E9N6(a*fLo_ zkAc{;o6$Af*p#6e{O!>n1VUq@Oaq?7oiePnjHJe^q}CLbKKP_3Cygp+oii=WHa!T( z94uZ*d|dmD-RrHeAkD2dzOaC%`!q%AnAB{0eYe)sZ@RwmiN*~g)#4m}ZcM*7uBYfs z56Vr)bjZ$ke3&40xCK)Y9kHNjweM2)t%jkZcX#^~DOPW{{L z8rgs{Fi>)ugund1sc{xmZ;6+hXz}~j`}c6uD}b7G2R`qlsmDR3DC|} z-kM8^cD>~e$mMwrKc{IHe67h2t;wrP?R#?Op={VIoZpYa7~Fodj{V;sEtIM8v!;O> z2L4QWK21jp#C@*If6lZJ9^ud{wKR={hhWU7z1ljRtvwCtW9hxpBF)k)w$5j!Yl|(m zptfuJEx*vzy}iD^{nSkduVX~F{%w4>H=gP_zOSs#+;!|PKyIjpJ9hGH>ny;iOQsR{ zM-qgT65GANkV~m(;r+j@Rq0*9-lLq#Erh+sUqb<}tb$YQDmx+?(Bg z$}y~)GYr{i#jD0xq?WCmD7`Ajn!J>@ye<8MLk!xv2TsvS+MSl@ilFb;nzi1^(~sV@ zUmMNt@d^b0VIywMnx0}`Tt#8b;-D_^zzxpvdY|)Z+^KHP9Pf{RE1=E|>jI0YeDn}G zV%;Rw5fIb3Ed}#2KdIU?p}-#Aa6Kg#TkKzQ-hlV1q-iG1zR+&r*YG{&tx4@i->R{@ z=G*S{-VW#Ct{F94?uw@V!=u8(3I0|;ywdM3#6T$TQ@UvrPL23})A)YOUAfah#Nl50 z+Nm(`m44}XfAH&x)VaOQ1OhIf?xqrt{(_$_?;F2(*~W*D_*mWX6a}b0ZpUAZ#{#>@ zlTYi6nq(;t2rw=%FNKDLh%kzaj4&}Vj*gF$l#enomzS8CoG~_@HlH>!qotvtH#VuM zs;e@qH?gv^I5)MoIJvgDyf{0$J2yKy#Kk$ozsScs%*)Kr&^$WKI@8tH*wxb8Iy~Or z;NCvsJmWn*Jm=@*KJD!8@bN!BK<)MOKlncQ`ThMsKY$1vNKjx9gFp@jQOFR8kcAL~ zJd{XrNW~x)GYb9@GK8bYjY5cU973`rNg_i~rbNk-2$3Q~ilCJF@@0{mMLH1C*&(OT zoE>@!4N9~qQ6oW-c2J7cNYkZGI~Ax*|TQTCONzI zh?2BQlDwT8cWvCea+T=ayB7d}1Aqey28sNhY z#*XFCLH_KSerNy&2u(FR5SUFi+=Qc`H|V6pAUf)tQ%*Y*#$(}y_3X2cKOA6~K>f3I;@#Y(Gm>LIMal>I+ zh#-U*^63jPd`cZ7*EvF}c9Uq5$#$H4N8Wg#n3CRlH@t$Yd+x!9%Y5|l63np13{#9U z{>TWZEHgY5NX>!RaMR6#;fzzxwGc+w!#mtw=*~PD-m{^G{CF5pKp+yN5Q!!pgyKXC z!8=ilEW(HpNF8;wQNA{slp~Hg(gYJtJ_?!BP6!)06j4AWc~nvmH~ExPNJ%LrRb7dN zrN(4|RhC*_aw(=+VvcDhUU#XPW}9!qso2YM)_EtMknx$>%?W6x!p@+5M%rkEChFSI zut5r`ZIR|?>2I7G=X9o>F1H-0&^@&^o&}_2?9w<#W(^AXe;SOpmVLRw}>$pAblxwd3hv^Qq zZbKzT7|C~Auq zs@iLZ&gSTCM<;#Tq)YP_+@_eafGPgUiQ1f~geX-au!f!MaIHJr*@ObYLmu&z!ffh6 zg|23?HnzF#ZNciru;^wi{qW~Md)r&zv~i8Wm5^|T1BbQPk&bLd$Or3y;o~Al56JO@ zTpOBP<Q%S#clsX^*XiH(}Lx*H8FCNUA1!G@Hup9JMdwNnzrCdSS#N+~N_5ldF8 zGCVC|>0@t6V;h&}#y37MdH~%E6ZFC|H^JZGbv2Tb6rW*WA!g`!rajNmF)$;w{= zD}!<)RxORiA7q74S%2%L2?y5$9W=FYhFc-FT3F0&ZEJ?$vf;S&p-gl!^K#BSkwbte z#38=Ob7yUljP!*~ZEll^t9uDJfAl(X#;%GB%WD=Rwj?J(Wp`op;>9)wmU@0HWFSlI zTh_?Wex3|^a!eB)2V=d%9F#G7WT->^m>E7wbbJ&Q&7lmXs6)OlksbA@Ba34{PU(+- zQbQ@Io-@EqzBD`9@gz;b<{hzxf^4=rB`Q>rN?5S1{*}LaW!yH%j9KQ#sJIkiH2fB= z6Jn#ODHP`6h*?Zy!ULH(?5aP$8dhjR(_PS%*EFkH&C!MAy-VaK>R87*nc$?ZLW&&~ zWtUEM-tI}c`>SAkXHTz;rJnXwqw>%)7svV&j*;EV64tb)f>QR5*;{C4_xRB7RVJbz z1|&txchQR~N~5iLRB9zKzwKejw7QvF8dzY!=w(s(L%7bI14xKLX%yz1k!TEiQ1Rhi60NO?2o zt{_U2i0suD64?sh_`)?{KAP(j^E*YJ%#LCH{oSG#0qjnU4R)S^C2WGvh!(CaRjuy5ohVhtT%|6t#oCO~OL_A{jnfg$u-e}Qi!%;>yl4-2v6#hy&$r*!c z5Q{j3Z8vGaN_g^X-wCBDY8Bk!o(C4kK5i_0<;n~;xw##rB?yh0%jsJAgwo2gHWsAa z7E+bFG4w9v$R*xo?odRROE-GqRaUfGGj#4Xot@>oqt^B4zT>oOIr$rCLI1a%0)A)k z3LMV@-;+y^ZVO}C$UHYfIF1pXu*92SVZvOG({u84_cjaaoP9XNKpV087M1Gtq1t^M zU8F}_{2SrS`o%J~HLfq2Nlg}TRXhGh;BI?s(+1{rJrb0~k!g`+3b;1&VT7-b9C3*!xwAK) z7|uQO87F>L*f|3|=yd|zVuBrT7!Rza!){4ra4Fux+2UXbN0`DAt}yj9jnGbOPs4b! zS;zYXzMP4#)ap|~$xpuOM8=Pi^?Rg9VGd*b0dVHI4wV31s8`+W41kwcUbcukN&8rH6wD;j=toj-Ds;(&+zcFJl#efo63cx1|#DD`i;Dh;L4F!U2P$drXP($g0BJSc|ZnY!$ z1r%6x6cpnW0DuA~V1-wR0$PXyDv$zQ*o8lH8Zt zU5Mj2;KEGob}wvIBSC^!di7Tn13XkXc^7wimnSormnWeXYMu8-pob`;cYp13TCBEW zNt1fTF;d1MNdSl({wMW%vsGh@FngiMYd9!VpA>97H*BPo9;P&0#)W}IcR|I6bU~F2 z$wv%D)pP+8UAk0dC5VM55R58_0xo!hodJWQmy9Q;a=1Ypt|uxtC<(7J3Sq+vq2Mb& z$O|5H3ma{qXl0+t9Uw8+F4>N^-1pvVqj9aLMD!_#<2!<&T zG$rQ(EI>c7W^1-L3DhVnLdPpVSU1VyOWU9z7BUa^P&o{tB5+3%_T>_MH-&*{ahq0% z8^&Sp2T}1Se~j3OkT`>kVtTID8wz)H9NO^zjagP z!HPQN3akMBi?XG*&|@s8R{y(OcFSi@nf>)K(z-VO@y7jkUEu?wUCXuaGt}^jnD!irl}67IS?Px zOk;(P@pdEk7EVL46G{S)hG_&dMV#%U8>(l6m|2#xa!T=`mOdz>9yATkat&6ep#Da< z4muikc!_QiIyy+?5<&VSco!5H+E=+VCGtp&DVTyF%7rh;GlP;*jB=v50c%wAiPhn2 zyk%^yuz?^*4V4;);HaRCb5-QXsR7}sK_q8QcyAc_XMRU9P@$@SL3xJwkqp&wiTIl& zS*3;Kh*+vowZR&b$fc`wKe7fj&gqiLw0QKp&oKd zeB()rOGzvr2xU$;Wl`CuQ1_l!X^(=sGhVnT%7~wc$}|A9s5*(S)EJ<{N1#54EZsPS zPvum_Iw9(CW)I3kEAkKy;jBDzk$7dK8LE*}!l7E|sx3&LFG!+}awz_2{;QYb8<&|i z(zqRNT9j+EmLWTB!-_)Q)*#2)180VpA(CDd;hJ(b6Lp7?Jz+(Bm8$Smo9yQpmgi}D z0;QWbl2RH`01%wxYN)LSmKWQS011Fk6LT|WrtzwP0i*~rur=0sojh4n+lf;`33SA@ zgBDbDKczt&I4r)P47Y?!2|I$;R%KJ^uv*B1U)ZxGhGJk@gEI*UyUMFzqqH`Vma&kH z32C5i`79-SvNtM2sCh0tnwMxdXCa{yPh=B%HJcl%s;nxgJS(fDm100kDf5G|DYc@g z+o+~=luf&Q)-akVWOWR3tYX(8J#=2JX+&{nk)+CRH9Lhjdzb+JfN`Cst%%sIz1g-@ z`bQ>Ks8~uHhkAOd6_8Jpw_yr^o(P>c>9^Q%h6Bl>JehmFs-3nnfp7Y+ugELnIi5** zAIT6@=$VTmI1PQnuv6(bCWwL`nvb9xx><^%VrdAbd%E~qHi|nRZMc>ncnwc$vgZJf z|~o2gGA*`eXj5kb@8ebVXKV02`i;iuMDx8^=pnKlQx^QC*A5;zdK@GEesZO;H z$VzT_xvV5|hrBDqLn@f=C}OMJW`hf(blw72TKDb)y?K#;v^Y^)op+8CN# zTn$!tvSGHv$&|YZfy~b8FZkwXQCOI7+!b<+M~A3c+`7+;_^qDTmG(QFk=aq^dYtJB zNvcx$moz|)DQId`3)q_059um0+&5G;HXJg|@}xdnTkm%A)N*uk2+OS_~4 zA-uC&>B?7ns3?3X(BT|6$f6vpN>|)A2?>NBH2#`3Y{NJFLc7KmsY7T&U#tVC*}eZ@c0zQ<9Pv$b zwO>q)q)(E*ToK3Xi&+V^J$2krcO0et{MU>agMW;_lvs)VXDKmBQmwbQQ#`;p`N)tE zxG|+$g`1s+i_!k7w3-Zy0{gh+$z;MXxs&^3x#+Y20su%rx4(yciqd|%+N!*>65GTU zb*|aGDWNjUFqK=pg~_-~A8a{<17dXra?Y1(yF5I`YTcSJTN18gUl;0c&s@)SeVARy zf>J%JUm3LjsGl-zhKulP1<9FbgN->5!(sij-2M>MEp(b8QvSu+)2W8Wh?gji*rg3^Yo^eY#81uo+qztAs=vB?{BCz1_2Xy1>?3IK9cc zu+s+G%Re2=K`qo}Mi03A1I&tc81de#v($YkU=;)1M}P!}8L=ho#O#yZ*c^~m(^7%k z&0MY7?lImy7}hj8IO!0~K;Cuht!5MHIc)7sT?^L>BiGPeMs{7c`Mj-t?XBM0S^mt& zha%ttjbgHG*o5rAV7jig=83gsrjCrJ{@DQo6kf{?n6D5BWNw<-sDvxR*V&#Nxk{-w zm8-#*i`wPf4XXVOB{RakkQ=K8a|QJLu~Ta1tik}gVNV@jSW&gK1NTf|F5zo@96ihM|Pfpiekp%ahak#0^-71oQ{^tNL=#V(jKnu&2c+jf%a_zde z4vlM${^*cS36g%a6pe~Lxv$%q(HzdW671>D_R%7a!J)aqVht@;HkIC>($MbW%2+f| zJmdY72))+Aqwu0w9H|OPAiZS%sh7%iLtf0C+Dz+J5=W#&q{_@qPOX2)?9FcPtxQ@l ze&sC|%bwE6fE)3d;6UEKx-hDZ1}d!LPB`7hpxctH{*dnTk}pXfcQyee=9?7MI(Uc% z7IAU!9_hY(t+xFB*LzHo06y3%dEi}ow+PRijQxoWpVid?*^w~m34}nEZP}`L@tPiV zI^MV%NT;71RHDsvdAfW7V(Q+g4N|$_r||)@+vww5 zT(ZIqgP47~UJkL(e=M#ysQSB$H}cU*y3X7lIZf%!sytzxCr_35=nXa0t4f+sR@&r>FF8s5)%V+dMblz z8nY_X3M=a>QwwVogKJ|W!|UtYyDNNSLu`CwT#UTTjC11*jUzoxjk80&b923|oxPLu z4gReozGHrlzN4eguH*i$!xJCRv%_k{%B~krcItZd;07-R7lYw zL^vZQ0{W>_r&2o{F+J7v)+4NsBsrqQbrJvo5Fj{U8@KJ;yL}PC6d017bVy zj2MqS{`KHIf4ZX9Hlv8qQ6OWN)snbqeb~)4#sdgq5QlFXm z2Wh3TnHpAZ8i7PttbGNw5&*1VXId^Eq^BU+Eo5z=^ObvFp?@fN1CRWgEzP3gkYn%; zp8j!9JPjSj5)VFP%IVu!;#?U}KA}2<5I~1{RA{am9o1<_vzC>ux4I@9ZM^+T`EJ7z zM{IG$GKU=J$RgLQv(piTakSHFeMsuwN#aO)kErMRdYZI1ZYboMi>@l^;s^eNEVI}$ zD7*s#^NYRr-b=Q=`$jX3gxFYUp*GfRV~$8`8=SDh42wu&i6@$fVmwnCyJ z40U`7MLnXzqmN_Tl99~ zF%M56CM9>f+W|Xevb|BpZ$B{=QNY9*R)t11X-W;!-n5$5JT6yB$Q5mRg_~Yg4s*f^ zmKQmvxz8zUjLZ_9p0v{^(w$Br)sn;^%=3csSi%yHkR9#BRSMgctNs)^(w(|u(Yrwf z&my@fB=P2DJOkb97|KxIgP8X(=mkuA0@H^6)R8@fEvy|Taads_21*`GEd_W&OP@`oz_qn7q6Xgcc$P)EzG8%Vz{t{ zjLKj2OoBgo=rbNS!W3gN1rxp1q$eBM0GBrK%)o7c14v|5Qk+7BrXVhHvQkasq&P*{ zSg|&~+9I%o1JcbkM>%2qTyvDQtk5|NT51%bv{nb6*2xr({;rE1L}YeB_85WbYxFXurrV3NGh^v-d~Olop_4eMTEyazssjSo*1 zBVE?c`6o&|ewfbFvTO20g*{pDiV=`@U|jZ zCU9?Sh^i9Hl!!|353rIIRji_wtYCD5NvL8K^+DECs*z7yODiaN3N~EC%OV_6s2 z7C+j>%ze?M&mrToq9ZzJrO~C+Qe9jSAyd|QtB&9P%IO`)H5b&5qCR0;SMS#4E}|N8 z7xCJKQfrx!MlJ}dkCf`aCrE~KGd^J)$d{dFGv0>fqGK87&yOMUIN79VKuF)c*vDB(Hs8{;VNe!JK2o`oxq!{~6GY{6R7~ zHkoC31Wh+m}P}`C@ zAdhz9=F9L%C?-?Y5O8!OS4|L`ZDJFWHw(4SHetHb5%&2q%r#BRS3mx-NM4Zb5C_H3 zQA$dfivPf3yP5fJyPXLT1IqyfA{NI*Y=~yy9Opkg5Q1n@u2l4VS=KlXy0C%GpEo+_ z-VDdkBo%4rjD;*R%DmAb#9DUv6zNI->C%_BH0&}Rs7|y;T%y3TPj$2ky9AZg{CQV^ zj{0A{Fg0IK)mMQd`MgOEtQ(fhEB?ZAjgDP=a>Bn3Wxemz7Pd%PW9c;EDGr4n5c8;B zXUpG_2)?0Cs>5VUf}0QS(J4*2ghw#B$+v-kW5oZ#Z;1T^V;$ca!tp4g5M4KApLmsR zKFuqg{Yqy$+vF#sr7Z?odmGc!Y59oSkp0cqp+FMmf~PpezWn52F2!)(Rw;-L$=SrK z4QIz*bKFPa_~9sM71UfsijMR1bgS3|$#rzlD-UVQU+zWjA_t}4O_oa0xHU+h4yKf5 z#2n)Y$87;U6YTMXPV@M++=W`yfoxaPo&I$H7SCRCZKPA7>L9SzJhBEbR&@>o} ziJ*Z&heG|)Z%4&K4ALmE*FU%xF=Tdoe-~o}L?uDwTg=pVOEPCb)+&-U8WUAfdM0wu zRdTrUd>s^h)#Xtvr-v}7ect7VG#DiBlz zJopqu#v|=!8k#qRO7=~j1${~QWLQ&+=yZ!jcXapRPV_TZ9KaxsB3m&e5?jcHC(jVE3*=ZQRHVPH(hoZXw+vp*0)`J$dNJE zePh%tW>pY3M_%2LI^dyRnbvda*Iu*Ze(=Rp@h5*_vvj}1bof_1|21O9@PGeDU;-!& z23CO4Lp@h@N!6o@3>aY!*gg7W4`nAYbW?BWxB_pXj_ubz?z1}~Ha{!mi^{+k9?=kv zl2>oTJ;(m2aES2|c#~$5;af7eV?1_)4H0?6H+&sHd7c6l-B>|F=ro-5d`XyuQu87& zm4V+K>ymF3k&=68s4glXNcik0go!LzD}q4PAGXtEg+-Gj>jA4%6cTUmdWSZbM=YW%m8*;#d< z2$WM*RSAY6ScPIp`CzOVVZ1gE-;vrQId3W269D zx*g(IUMERu*0Qh1sc$D*vZ<$fGKq8rOMf=$xtVxK)p?(zdmzZ544-Iqc`B3?!n(9( z4f>OSfQoDB(13(ms84yQE10N@N?Pv89uSe3RA_3)!yq65ZC+=dHG6vl%5ZAymTZ*zLuz{^Y&JwSIE_71y$acJs7XN(`HgazQ72bLetWKftFHcqM!2_`eIEIT^6Gtq z*eBuF9jEs?E6F>-MvCEUE1o)i-!(d*g zv8rfrg4$Ib>#@jaW+)M|BROU6se$n23HYVL0amQYa5rr@%s?r3Uq#hp$ZZ6H!ZG#d|p z=f`Vl#ng%=qC&`{!gvhSzhJ@v*F!jg?u1nCyf%_X$3c*$S zuG=TdS-Q9t{F_@tEgJKs=7(v<=`9|doB$hNX*yrJbN<3L38yOjADd`AJPE_58^c{T zRja$FteYWzDh>-6c5Q=#gG#7QNnsUsdvqg}qjj~78inz}wbBU;4hxpgV7xShVtRaA zm7)@t*>G3vmcG|FrD8-z;Xn@cDv<0U~sv`IlEcqvg8D%xvuWSS+1(N%{D?6;cy&zwwXT%=ttH&UUT zrQcP`AUSNLg%DjGxvBFyuCtQsccRK!vb5||LEWY&9G#x4%lkE_bmzhXrkxWTYyQHz zHB3Dy=3vu?4mC7wt$5Xj3X8e5Lm-<o!IcWNCNi}Fk23-D8&K9f{dZg(7V6R z)S#OY&qV6Tl~qw1Dy|(0PUMJ${T!SAg1yOa0moUZN3LMd{nZPLZD86xsGWMwC{o2& zd=sNGDmlS;U*f;Vr9|_rCiI-waX50WS%)RPz<(>7DyNZCsySfPktfxCyb04WJ+CEc zwJ3>RV2Xa{hn#jK%go7E1k1UoAPXrRr#NXZMx|N1A zu2{e0z136<02pZ4Qi#~C;9u665!?CRWEs1U&0;OVL%T)UYdgp|W617oM4S!Ab|y4V z(a{6kZucxFeO;0KoZ$ZK=uAM^<@?nIJ=FYFJbJ+w$Z&THW<6nU7|FOGS4f_-eyUfY)uz$jl)MxK*80LrmF} zx0}0KZ7C~p=Dmx}YL32yqGc0449!ptU9VtnTU_ zZL3j~=mq{~jPB@y%>t;mC7sDUpX-Cmt`OXZI!^R{7}GKBo858jkvk)TAXBc43H@58 zTAO-5ts`5@PD6c@Q2s6qQoij|H+4UG$5@x;0%Nfa#vwTz->F!PJ>0QS2}rAL0owO-gh)NYU_?6@*UPy-~Z*2%dxr zz62Lf*lDg-m#WKj3bse$7h@|9;H|vaCh&Rwyrk~oaD6Ha1?bkh$k!CwQ!&~Vig~s2 zT+T<*wQlRTP69t)n<`zniALLrn=HdFbCG_pR*SE1GzoNcew8c7on|}6y{5^ni+1t3 zv~Y<<_4U0>yr_$(;BMWsR+QQuy9&tNe^1V~OTRxX_lWxLb)SI*jrCmX3;kuO^7wir z2nahlf;)ve{yRE}Jc)@tjyjHxK0Q7@KR+CQmzzI9K%Rd=nL$E9K|?~QszgIWM6X3e zMIA-8Mn$)|9Y(xHyGBRAz(+?&#YjoWNJ>e}%uUcrO-f5m)z?hf04*-v-7qdNFXJ$o zf9L4uGVAO%HaG7!I5+e+IXL*4goB8NJBy1T^?<~q2aigTeps@^=?9Qc5KWaTMJkn$ zOs+D%lJ%!UCR)32h3rLA7_pPYlpImntfez0FqcqUBJ&zeCIA2+K#*W(&!0Sl{v66P zfzhHylPXn^fGN|aMx8=!s-P;>s@qy<-P(eM3vS)GfpzhM+Y7QS%AQqAc5T{maAAO( zE3U5o+!rxkz=$E2FJHNGW$cYXIEIYEhZ7rSx0sy_caUR1o=h2DJb0Mj)!R&Op646* zLW>T)L-dXtrBkCmy-$#i9Is=;9t0avY}<@->(&8~_dg!Mg9|SR+@SH}kpOt}b~i3y z80(-zZ)YQhWg8sK)yt7R2kIQO3-yc58jnbkRp*qLuA4VE3w3qpGO_>mkTbv02s`WD5+$mGcHjB(@Znnlnwq) z0Q3~plt3M2jgOrB+&Gp#@i)aK#nQgmvkK*PVI& z)t7XF35FPA&>1G^I*mD2-Jz0Erf58nWri7NoP9PLXrtj!nx*)pmT4iYwdNW>;u#_v zBZ$DZn{K@gr)qJm9#>E#$(_YqIL-mqr(rPIkfA%6X-5xu+5G{Yr{k4ZB6^f0tD+_C z0da|o55+i&5H!}u%6+oPq8}|k`d8AB0v1zDGRYwM3^da~!yrvg;w0;wbLl0Qg@YEl z4n6X?)8Vf;+|zF+gWzz;!2cL4kcpA_aL|ejx#wahFj7QqwHV#F(SAjI)c(Q7BbCGp zxG1e8vboJD856rSQNsj;+UO+I%T*G!<;+V>B^6XRi>b3yW0tv@jDV0;N?>tKNPdDx(gWtixqTwfLs4*JRiX+4rsTB&JhvxX^af`m8QYoQkM z_Q0l|dTOex4rg3(d&6pw4*YbD%5` z3jxvIv(bLSfhnV8jtVOr5Rn}$nR779EgTquIWMvMLVN5XBT?Xi=PD>ogEl>w4GB0g zXD2y;(Tf;6*Y zIe;6;Ui%T4*Pq158ziwo{u{ic1m@OI61#-Q1QL)SCsY!O%&wFaq|i)DUc%W`B*-%{ zkx45;3)*th!of8Wtu5mKAvq>QCp+E6X?l`QV5IXWToDRuSTmG6B=Zpm^iZIr1@2QX! z3_N`09ma(xSm)rtz!p)xb6^i0*{KBQeDDxVXd)sJDP4AkkVXzX=2ojLxHosa<1 z2-*1n^@kWbCKL4jKx6dG@w{Pmr;j5-BOxhg zBFOb|A!u}^Csdi8iV%TXe+=YC(wDK0K&}IQ>;)i?KuZo7$Uqw)WFI9NtV*J62@fJ3 zlwhX7qEs_W4~(GABzTnyf~jXd^TwHmrj-x6Wi4t+8aeb*Lc5$0FMIln)ck^>K-DWT z8Dh+#+)=|D=I~MV$QPu_cDB)6iinzG&39S@DkR1&5#y;F6d8dxDzd7IuX?4ab!XIw;hhU&_K;uFN?-bMo->D0DEPMWv0gI3({OR$#;& z=>w+vHl{IikR%hp2o_We1W6=GGF|J+>i+NwctA~lG%zt3WIE1anauqml#atk4$e^s zeYE!v1tJgGr z@rq)s35dl9udd#!5OVxiSlEKszU)Xz5RBj<8Kc)N$wbMT@L0)aqCr}P=2nSk<<4rk zfuY?}1j9sHFk7(985Ad+;N(H@$|<&Yc{7}$wwI3QR=4-eb7S^NnSL%R)WjujX98U| zQY)9amqK)E+!i9ajY>pJEY?H~1`zEMhr1iiqNbHrxap9$yj}y1JkX2Mv~pkvCbo@x zfdkiqXn4bQbjW>!U~U=3N5?}r#kF!BNWr>NnT1`dB7^nRBP2r^$d;ruBK)KYU(yMI z zCbk%fZ*nvA9SyddgI!O8W&u}^cg`;GO4dv`m%2>aZg$g~SlNmORqLh>x~VM`?_!$) zV?r7WBnlN>i3d2QGzUQx;h+)?kasMki^R8GY%7E_cEN6VrR&Jt@6aaS%v5u{LS zl$T3?Wp?TCYl=k@PPIx+<#q;w3~^^w%a&D{wR#4Gcbnuw(9w5~Ay)NQJse;U+}1C| zVq&X?VyYBVFE;*wGi89}_AotFOZ^2@L2xY=V zhJor*cNE5Yn*}p516s1jC9_9CV1hGZa(fRaalH2x<8U;-_gY;AFYOdwP=kCOCtmjC zLidzU?T{$J#b==gP{x&gg=SEP=3Jc;B9691iC`+VAvqI;U6r<7ebZg;_kI_~CoYsB z|Fm+U(LC!#N@}DC!9pCY=3?T;EC;A{35Z`YA~FBvM;Q@Rf%FkR24q2oU=?T*#Pn1f zST5$GY!HT3R!C(AL;@rThs~E^f8ZD;RaPIC3IDuL~(BcUUu<@#&>*j7Bwt17@p>Qp0qVJw1?F9C`sps zf+i_}*jxx@M5wVE`}Zl*6)H+ZD(AOz73Fi0*nZws2}2i8<0Tk2l!ASDT$>1uPInH6 z&{BsNQ&eYD1IPj6)-0C*5ehgFrr=+D1vxi@MiIzs>=SIZSZ~6xNQ`t$9B3}TQ;#2* zdLlTC{78Zoxs!&0g7tT8W(AFbCzNQkR=rV;tb{$K_+kgBQ?-O{^07z$RWaBi3$h3j z{<$z%u@h|P(0TV}OvvC$P?#>%;7U!fGT9(-X*q&9fn~4Pg*CHqr3HotX+dVFkQMh9 z51D3NM(%lC~R; zNRzE%lQ)Tz#)lz!wu~b=J>1c2-S!We15?CNQ?SB~XSWHV<7ym$OSQ(G`H`3&;bDpN zYao-0Pk2AaWNa^?Y;y;UbtjC(=$T$*o$G*}&7&Q_0*wcHmqm$Uneb^$P8Nl~Qw_lqjQhw0YuS&k2apcLg$l?1O$14! zW4JS9C}t9;nyk5+>EuzxCy~`DhxAmWCU`Zyb%%!$eM~A`C?}EwHE79oHpTgUma>xJ zcZd&VUFb(ql=g_xiA6z&A~dCGP%|j=*H2=Uo!U8K8y1r=g$@_x12aVl3PGpo@RYMA zc|Vm3wzgLrwj%;&gus*zN~Lz62MqUi4&-v5FhNyPcv)zvSu8q?{g`~r#}0go4ma>& z>E$?rkPgMdRsbP@aVl5mun^_8384Tn=`adFwP6~{V}&YtzJREQiVgx|WaP48NpKG7 zVxkOU4#Bv3m8zCjwuJ~MnorSirRhyMijW#4AwHT;Z_4fx=t4 zX();E7#>M|eg>R>IB1mea#Y%VN3>A;Cw@&7H>MI%==Ypd1c{e6reul`0MM3Sgo)M% zl-l+h{J@CikzGHB5DCE$ux6gn5+fAb3N&ILI+8y5kstlRF&+~jjT9`8#5-mQsSIL; zB3M8z>I5unrga8J_Y#uZQAYMaERsVaysAH6W2jnt^e2T2sW?Qt74B0`fg-*gJ z7eX4KMCx(hnvuPQPmNKo^w*okr5WlPr6lRD3AHw>0j~@te*O+6D&*lrGWn&@S(E;% z9yDbM0gGX~^;5)hQOH}W+J4C5XSu~QTqBNnR)4>$xmLaY11v;YEZ zATtcYwq(baB)@|$lDe5`d91|9vUry#JLz}VA!zroxgnyk3#&chDPKJ>x(!jf(J~4? zWot$IfV;$Fm*=rf`z^Q#RU>O44rZ3rU=19w1jO2(nnjFT+p;ejnxg5f71VI2>2POD ztv%YKu8FPiqOB8|C$;G(Eu@i-@mqL1eO&XTezvZJ=B`xgeJFXHpTd&UH43gW1`8oCksL8w8-c^3G+ zxu|ba#XFOf1nZKSyqmKB$+f_%X_-1w_;MNhVn$6jEdFqQy#cyAiz3iFp%4QfiC47s zF{?@Yy1wACLGrXbd}NOlcV>CDSlgczHiEyK#5%F8S|X#PMSBH#qdHTzVzK~Zg0>#i zL9Pj;bP-;~2e-9pq*W8HFocI4nYT_lTu>UE>^hv=*IWq&eiBR@vSD+JXd4oxxOc<2 z8w_-kIGvFzxt3_TaXC6{qzJ4i3Ovc1;T_uNzy_6)Y(sM_*-+En zvf`pUX&gyaJH*XAVf=W+(%iKG3AX+JZU`#rZsuWS;W$j`vU-gq=wOx ztsE&dy*8XY#k*l5&HJz{BF;SJb!!cT_F=;uTZFm*Y~E|k1Y+08Ott!XRn@T9&z#-b z{nx=eu9y+iJ(OPi*V~L(#TdoHF8spYXxzt5!{}_o7&8+6QO0y#*9`Wk&QP^8!Jq1@ zvX;u-UF)^+E5FYwhKFsC1s%xd1Sc3rLb186+#0|ydz<5`A$o}0eApC@))%){ z&0RjnTNYXcDYj9e$B;hI3Xs@;>aKi{TY*(K3tC zk>cSrD@21h+AaxQ(N)2=fg7tm%B}5lru^bCPE)jfI2bO|9+J%ggNRVapsLmbHdv?M z?B<^{v7JE94QRc|{te8+tmpI{Ac|VoX)NVs`HQ-{*I2mSfBghqzFPzv=7L7%#7+od z&CPJ-<2FU7HRa};FiR4e*0>}DdliJ}W7OLs-?wPS!C(XgatzAA0rPhOz(ud(0F3AgQTr}(9 zK%`KvP8uVwP{*mI?j9vBvg(vM118}$g(WjzU6N20ZVOQF6Lx2 z8nR9|DNH&3Ncn#XlOl}Q5a%f$F^o$zj1jF1_Hf8Md`&kQ(2|9pCW;ZRuhVkN}{-fB_W@JZLbX!i5VL7<350g^L#xTfDG1k)puS=J zDbw8^eEa(4+bOW%z@U8m01&h%Q=(4^bv49jhgYwU9P!|AN$#b&96DXMF*3xELpCaKV?-6bu#rYQ`Zy9uAdyrONhGO+l1nSO#NNVrkGM=9&$)zl#vJN4wYQ;2PL3kaw%w-{qV;ho07sF5bSlDpAfG7 zLCYn!jEWgAMX<`jZNQA`=`zN6+9?vWVn!S`#$BjkH{X==+&a*$ss>w$kH*y)10 zQtBxON(}dFH5Fz!4hhe7*bcHHT6f(%P?(rv#4Wl=aY7YaOk>6lJ%l5UI#MK2j}vhe zQb<1;K-+=>2_~C9}!B}MD!Paqg*)6ox=n=*>j$(=grCk#l!cY7%|1>uPCEJ>1W*W#y58S@yI{| zDP+k-7J1}KOR|*G%P`AKvnlb!X4(PDP<*m8qm->FK@0xV+0yiwuBd5(TXB;G;RLlg zO@eAwdyCbumbIBQ3}Y;kaPI=EB~J#i^e%#Ko~Kt*ZtgPB;!VioN|)$d|MJYGDp zU&SlNy-<_9D^4gH6567#oHsD)4QmMoLl}st(>aELE_@IxUq4oa5LB*@eGO?}`{D<( z9-Ry%CaE9FRHi?c=&wmkiiu62G$kuhX@Eu1(*BmZ)H9!fsew_c3em3e!e~k*X^v1D z92HTP45npmY^mDS^aR2Ya*c!~9MlO11B!Ga>SxnB8zLaHh{>!?QdZjxUOwY3PLu*v z{bB{~LZi1?_)b;sQY39I;ly4P4?)Rj(7hbGph`N3Jr^p@AHFCKF>(?e9PM5xMLEhS zWG9(TIh!F6@uqEhFg{+)s*Gez*EiYROaD`+jTs70G-NnN%&cr_5( zrB8a{S~<@dn6Pysohsz(qPhaZvy_KCaiPR!^1_Kc&aM=rxCEtuxSIV8@`wZl5N&Qd zyr1p{LCUz*6&n{hdI`5v6|%-32nJQCdh(N=V^$i~xW)wnHi8#asRvtH#~b4D6SI4d zOiuw`*WRsn4uXxUa>3I-_@Wm=9cpN*2(RBbLs!EU?s1Ic)XN!cd)eDw8NEjjtYWp4 z<(rr)G3KJLhLvMtb>#v8un{5gh-9?<5sy&DGF-OgBysiSFIf`I0rtcvT+-PwdFI(= zGIMBBDH=)>QP@U!1uWJgOPrqmmO;m23$inmEM-M#*%D&bFe%(D0HkYDqa{|f^o&an zHUJ;@d?t3Q-KTiL`-)XCad+&htwDY9D)qLv7`HiwGJgA8$n6UokjsYj1cqM??U$ob z{V#w=IpEQ?^Nnz%jAQZCxpU>of(ok8R|tEyVS;wvyg&UZcBJ{ZN3k<$Jc>V_6lJdji+(Bsnfe2csE`P3+a7%IJ~;uWbvRij^n$ak&x zRk1Q$;u3deOJsh3(f*y`3BTcu@POTG08 z+0|~3s<;opOA`wY?5^O2R3t7OemLVb@)%T9UZ?k!R4!sX;~NKKa``((J6A{5S7mjp zOn%+(?EbmT!ypFnu>+`Vp5V+Vdfls@`|3sqI;IdV zd@)M3t?i~+5Zp}GaR+-0POORZPv}nfIW@cPb-%l$rt`{@(ell^Y^GcKjN7NqRkzqS z+BHW+WX~C18~#cO4|!6=%rdO#&@5Jx&FrZh2bOTrVPy{LAL`zn9VXx?m>lKRN-2{| zn~9gV^fT<9T@UM1u7BbRRjE=%yUwes4j>Y!Kqc1{saSMLG7mGf|J71)FY2dy+|=1i zmKmpB)v5=d!2f`C)@78wSu5m5WWBY==+|o|V|KfQc1glvy!1bA7h*QUfLS7Udv$W8 z12lOjCQ0^AgH>2n5qL2sc!XDYJH}&hQEquLPJ3}#m{k~&2MS?x7?f9e9Y}BXW;G)u z8hF%QhUOqlq#F8xREG2)N|b$v6FfqQIIs6!jk9T!RDL~JAxo8e8^V64hH4^54+s?&o{(w`x`w1y|<}29|XQCJ+j?U>oCgI0AMMF=3TxVV8JenP`9q z*kN+jc5Np>$tHKrR!l|#ZOSBVU&2h*h9-OGci9Gb*Hm2|Xn3k~C*M?VT61pX)HUk1 zSt_`KEoe5TGmDi0hIxV)eUe(804|_FALGI)!gUJ%G(?UjT(y9WkwygSbz8#aM3x3c z%b*Ox6;Y6rRBeV0!_|aKuyIgmYIXL0@X#>8hgF9te24*9gYaT$gJYyMLw=$jurnzB z`ZOBP$SJ763d2Q2J4Xw{H5=QwaO$N{!nGU2WdzNDgv`?^Y^DV22rNyPT%E*w9}`FT#?s#t{0~N@OLIwq_%_W{H>hYa+3U1{f1jk`f6>S0NU6%_bCemp~-d zSJYN*7#Kk@HWeFaSa0%e{U|4fcX*MNi{{3Qf}(Da$8MZu7)Q2u#28O;^o4kmUFU{R zU^xo=1YY-{8U)unyJHJ=sSDb-aFnJ{yMYW5w;+GHX;}mz92q^*6FuO7aerVAy9bXY z>0I;}KK7`R)G`&}F?capT4~uQfMHJE#Y1jsbEtqfi`F-#=^wSQ3kG#tLdE`?jr5Iv z37C{5d%dDmpvI2qw@J;xQKlw{sTO}InUeRYRf)KWFtUhTS0j-)iOUILH;IV@C~QgM zGCt`MY!@>@31V?qKssZT$b@%JL4omR6)nb;P8o~cmQol5Znb!oJ?3MJS6Pi`PUn<@ zU)gS72>{>mf@K*eD<^|+p^JUd8Nm3Nuw`>YG(@don*MQ@cX?aCz+T_jntdsb`VyG3 z$B`7mMeFEix(F4>5Vs4=cY zlU&Mw5M~k2sfh%*lPJ-X)#-`Aglr5*Ob6s_&*q&eriy>Hg(`Z1vB-gW>LzMIl^TRC zws?!=_MVi*7eUsGzG$CcSqk}S74pU=i{PI#v^p?4kj=P5ZAnvbnWL~UmkgSkuJWVp zwU>M;jt#{ilys!MQkWSh4!5V6O)6ErNrlfM9G@nvF!NL^@y0vuV8oEERQ_iK%;;19Bny4k99@Q!0E?AX3BmYQ@Qj z_=lXfrks-~iD1{9VoD@!Rid9E_8G?eUc!Wx+LN;Vx8F`p`pNvYDk9vInNP@iR1N5;&tOb{%xr6*snsteqO0=x2 znNY~!tgvaJvNxE-@n#$v4#(A`{Z&RKIie+JqT!071#5iPbv3#ukQM7gr9iAWnxH02 zmnq8&pbBQ98lkLN3^4l)(=fAa25KC7Q63tFy%&!p@~u~Rh~g>*5YtuW$|ACcoV7NS zGWm5jiIWzFOGYxUXNsmD20)<5rdQ&odUc9?6@lRyG<7OXuo#PwfK5xLu-asm4LgEb zX@U|6ldrK4$x~;>x)y3WJ|3gXjUVFf}MF*lw6=piG-(qc;nU#=5Dw zaKliwq*|&L3JsJ*4M^Ix$mNdj*ik%7w(?i2QGmAN3TtaSBU_iQ4aR@%%C7ACt`KmCU*}iE@uJC)DS(>i(+of-ndL=bl+vf?F9VU5U9-JPJFsxzwdLI8Yud zhnAvyZZV3&DEx1qxwJp<3R$){3d*A?n+se_8(!?JLN&X8`3(OOzSP>oXKXzlYAoEd z#_s^UYE;B;e8lYw0C(Df^>)e}>nDM6N9^`*Q+%T&OUq7+jYA;A4$7?B>#{>iyYn>- z5u&O+yc|Egm}5j|&DG4{%D(wby#4^7N(tuAUj>u{K&ij`ohlZv3oJqJ^uT3;ryN*}mK?c(dchA%x#%`z^{KfZ48n(T zfu-D7E}9;M%E~cE3WgCjZ8@@=syC|pw5X|lD@zRM492CJ49~#M|KiTrP|O4q4*P{Y zI?Jt82z*5R1Sfi;aXbZ_n^;dXT9RtQdC>{myl$AvLkB9FwCvNK+Mv2T48YLKSBt}^ zDwsGwFX{x5ozE$0h^FJjo<`>$iTJ zYy>2C1w40gTDVG?kJyG%8u-zTJN|e$#>7xF(j=XD7`%&>d#LJ`s8M{=`*g7=xJUQcg#!#)Z?Z*!G{5{Tm)mL4_ zMI6{uu+_HB#Hr)NCQK;YT%$F*)3n^vCQIDAAj32a3`3pHa(!mN>bJ>)w$+(tedZe0w+z`bEi*X_*I&z&5?!g2l0o9%$UcqY8vZQ%FNl7+qC4Bmfu z%zp;0=wWwZLsEc%yms~K5;?J^I)T~RK@^E>(MSp6tLVs~?a`tw$=5;|{g~q62B>yY z(iptS8;pXVoYNs|<1WpQF(}iTsR?Bs~ev z7=<}d*M7_;qStMOL>$ffECpRY&6f#+AN0fmsi-=A)`)h+oGMV)yT!sT-^AX_y>+Vh zO-ZzQ*T^vr7zNe-X)LzZ9pHa$qJSRgTW6e%__hPx;EQhX2#vRneliu#KO5#tX^Neg zE%A8OuLu0EjI4L#$-o@#(W7lxZ6d*^U6q%d>TQ9GgL={@2-_X}!JrJvH=Z_CiF}Lq zt2Qm`HA?Q_Z0=bMwYhxUz98SdTs-a$9CwJJ#9Un5z~6xAUwr<1BpR7oZmaFvpGqDzHZCc8`M9)%g7z)^^MeHOs(1gEEuBne;Br>_VoOIwgg`FgZ*la zc-UI{hZu6Mry2X3x*JimXR=*wxp2kox-qwxLvGBN=OFfoIJ zGBAcRF^P*Zjf#zqHZhVmGB%f(nKn0@oj07IpQ59mI5;<_IjE*LIjXL%t+2B>JF`2u zwY9dqxW2zSJHf-kI>yJyJUYtEJkHP1Jv`FW)6zZI+1lAY-QM5bKi=ZxK0xL^KkDk{ z>;CFMKLETq#JJ4MI@tNvKH25&>w*9QA~1+SgF=D`8M1KU5F!sB5+PEANQWXAi*ztj zgrkv-MnZ}lc?1a(BS=anL6W4Uk|ZycC~4AUW|JjLZr;R6VhIxxKYx-KO4Nzbqeh`P zQ3|E0(BsFO&&Z*O<&!9ky4n>OeiDk=9Gf#z5wR4oLST{@o06;+k z(+W_ZMxFZf>eR4fr(U3dHtpK8ao@IGdx34=z<~pJK^%s07%z@1R~|!9b3%g-{z*@y zs5+xZkQ!;)K1ma&OW#A08ZYXUsq?9F;D|*_7A#)7YT@YhtG<0=UyEfF)o)+AK&8KtB{TP+JKp6xTu!%|(|* z9ck3Ti+PE(5lBa%gc4vW4Ytx@G0kL?5;!%+lTVQi^^+4MAW2zLOD&aIQ=38MnG~Q+ zK?N0~?Sh{%_Y5daS=gWj5L*Nxq)-qiG6YeID`s@ji!iphmq;fW0oa{_5ys#x8DE9|hu7HjOW$R?}ovdlK??6c5D zEA6z@R%`9G094A_YOiU!DQ=y5np>!&ib^V~$fc_4bFD%LD|ND7mmMVAZ3n;!_@Zz^ z3jFe`!oL8oAn?E}6kMCl8go4G&K~#dbI&cX5c1GOk8HHUE)eH}sW2>! z+`_54EA=C_&YRs0GJLlQdF7$!wJGX_P0QH300WGE_xz`}mu3DTh@dzQwv*OCbk|*G zTX>UbP+Vv_G{oO?Ni@;mgb$8U2Q0n`C!BoE7?R_Afi$N`HCB%2ohfB*(&jqu*wW`c z$|O2zmTntcx8BOe+v?{2M((Ji0+8

NeLZt5d&Q-K>txi!vpe+>39_GvA!T&I0%B zLeWMueOz;fT#|AorL-Kg%Q$bW{l+ZpOmqt)zmW8)FFXewCEZc~iSWY@53~E%_lrUb z^A~Tk&DrPA!p6yayh6}F6WaHdM?j<{?SM)XpK+FUsu(oPIJQI1)ZkS$?PMZrmgt1~ zxVDO~oo8&lD4W^#lMF7Y%|AXM5H`qyjRSos9SxG(I{xfNri0uKZ*O_anHchxA)twe zegj!@xvzN+2D#FvXhG z#fEj@LgVUQ2fNrgPhAkiUAuA@uR<_lUiGRM`}l=|KH@K6$XkKOmKU@FA~0PIgAT+X zHodJ?4_`3rSN;U1g8db&1^*i$0-e@Csi9A0r~rVz+Sk5FzU*a@q}l!Q_b;7skAKOl zq$M%wv7p)Vd*B1v(GG~fdj0*^x@xvC`5^9=vDqR`Pm?=)N&UF}VT^kv&fKt(JIp&K_ zNa+}_>{RV{=?fkt>8Hw??Tmke6d4Ohc1Tn`j1bb3nEK3fFPUM?cmT7c3W6p`0p=2X zybNY?ruNB+@pP2%d!H#&N!6P93x9vim@7FZ)S_ClU|tp4C2=V-q=v7TN=p|fA^5=O zl&_d~q?a-;=n3$MqM6Y&57^K{q4&4~KK9AxF@#YJF7@Yx0jh?9$eADyy)c~-s#`%q zWW&6nNg)YIh&+1;7l))sMMNy(T@ZKvIDWp!i2(%(c<9r zOOP2gm%H5V_!!o-1s}ms#Wiv9mBQ|)oBr`q zfyT+$aE#-zkp00r*%>0X;Lt55>KkX{QcruX37`2Kt&5iE&&54api$gQYYmFIlE9WF zvR!Cx9g5o~h|zQu^{u!t%0~V!Z*&0+@F*NlCemUSf@;1q=_gZaFFvxAU(`JwB?)FQ z_v(_DsA^dB1o26Ti8q>|eDf;*C{%+9a%e7?=`R(CE>F&PYvu_hRHuqxKMGostL(4N z2v$k2hP9{wB&#m(d{*%(aKR2Gdim-K%H?uQj>nd$cpxv&T}tOuF=| zAEtqty{-QDtDW{)sAp2GXWQ)oroZE(MdBSvN%lBGyF zbf^2E>&Bvvr2K9wSDAFZtv75ex@F*qin#mcXqf%&-7*V&xfP@uCGePV8<6*^asDq? zYpGqNRs4M5orIt18|n4nz+xUpZ+ao#Jw%(;)ZLxqnw|PgSG>NDQLXf)XP#B9`uE}f z)45nheN=^k{%qn4{^ipi7`1>CBCd+4Fs!NP3G#556<$-%e8vx0U)N_C+B8OCiOv3D z7u!qKU~vn>zMylUv+R;RJG7;}_RHpQ$7xbeKQ?zkCS)&S5sMRUP~aqMGA;#YffQEX z^8zg}aSvu3hG08=rg6^{O}CGH(p5iJHE674 zbI8*@bXH53bYQncNFxJ26US&!Q-)&}VV9S5OqWOEAs*j{Yv>^#A4W}pb$*0}3?`-@ z#I_9n@b^vLU=}U5ARdAa4uXH{6a;8@Lz#6ZC2}G?6o5h`ciUEg26%vZH*QDffJsIt zAyFqOp>7C87<%Gv4V8f!m|J9|cxSX_t@C*M1{@s4Z;~fFwKGz5v^(%paI}(BmS8~% z#|aj5UM?kiv{!>SSX1e;gBZtqc@=~o2XgxpRssZu@Z~)2fePae!c$7Zdw@h{AOi`C><0pr^Mt)aUSnDTj z?N^Y~z#-Sr4P-$U$~K5`(``!2}USZytzm_O?b|_KLm{iyc*cZe@#U$UC~&f}O{G0Pt~g zW{#vMamR>z5M~JA1u+QsgE(LVU=xJYbu+{WG($5}(3gXYgj2t>K|nYQPxy^eI5Srz zj5T+B=O{?hC|1iCG6zPD2qT7g#$ZDykLz-ab(9JB2uk`0eo{wue?^BQ7Hk8F4136a z`rw%H7l@7Jkc4Q6&X$O0!ibugLz@LS*%mmH$Zd6}I76m5jgyH1MG_GhfhA!hpQt&4 zH;OIEBc>=5G=X@DXGV;7QI7X1IvE_2M}izhi+w3!nAcpj(j5o4biarRNB(I%){y*>#b6D_m&4R*71UJE#R*kel~zd#g!w^NNq&gAYXPZ# z`_ThC(3tM$m@Cvm$u^nj1Va#+e~1Wed9#QX$(cU{7Xk>H_~enKsW^<&5sRaVb3!8_ zaguoQ7qBUK3iT3%*90v=q#0NfFllAFrHUZ98zIPLkjIm-$Zy0MVS<2ix42wZBUhK; zf^66cM~OetiCxB6oo47R;H7lT*g;f>3t=i}H)m*w=9S!qE)m0L{$sgJ--imbKuz)q zj?$$9_GzD1SdKFYmvQ+&UD%bjXI9IDgeBukZ&ZEOS4V1Elo|F35Bi{h#tP!+djDv3 z069VesfWVQeh68R9O8BJC!+NSLoy^|W_O}&!G9`>Sv}OEJO(%eI1vOWn%y>|3HT9D z1UaeccdKbRuZ0o_)o!3u7z{pqXj}{tOTVi4ynhzUFkQ-VcD@K1KIzw{fZ2C8mH+HLhgKa$qngpm%NpxB? z`cIhHI5}D)eOFK_xsn!0TP$H1FCndn@kKRZn>K;1xv8xnc$4{-ld!{+Y)hr%dOOBx zsawi|%vqG-u?b-sol7~dd@G>wC2+gAQ@5sT@aYRjd5&_*Jcop@-?e+0%CCL;3$Qnz z7ehZ18?h5>s22;DI`==Bw2q`kKw}uGvtyuf1aKvbd69|vbsyFh^Kqer zMM501x(?>>AZDk3wW>EN`hT7InUelE1QijZGHP1Gs(=nCwK}?^$tr=E z1Eix^crQ_;Un{L)8`8rp)4z*)U>X~sO-V8!D}84;9k6nJ35v4bfmfsOpsCObdo_nLDhqqe{xtp`t zu(LbMv)tgja5Hu?HbW6Pw3TJNo7oVL=%T#Zs~u@XO}j*w2vF2JwH-jUJgRO<5L${T-FnQ0Dg3P75cr;h|t3mm=K8S0C&$mg3%(s`fp3E4B{t66%%s;f0%A1sg z`I?RVy2-zgei=+vSCyYv=$8Cx{>mC_OVb#-?YLbZtCtPtZzHRW@1k@RhOjA1U*6|o zuBXGIiVK`fs<(R#sH&kn9mFcev&Q_pN*q~|6(W>n5Ygtu$BVpD%qH6Ayme7pPFu}T zOK#I^CtaM?+I$3EjJ<#n#$X*~v^8b$W}DzUzBIuEH<8ZYa<;+cIwSb4Q~Is!8)mT_ zw_3`AR-=7(t3iM4d2=?%AtRtJ0Kgnz$OLUi1PmVBiO?e^43HdFc6NIRQ^}UBQ{tt` z+;|^40DG0ImK?m%7TeJty?hSssG>Wdt}L<;6jCL1D<`|UZ3v-xC80O`9<_VZW|N28 zl)F8xLa7>v=0ut9K#0ozjMQmYk(h?O+QFA<{@w~qC?7n0szp{d6ES=AodbfWJ$UGCTg!}@AZODc^ z2><&BwBn15t&RQq*vbIOgT!-*hJ==#a%=d59dru`j0~dW$)N1P#y8qL6PF`QG$H+S z0!q>;e9~vw!Y+(`;nl~p9n)|qHgdSjy4}krX0yQT+XOPiAv&33hr|ORt3nG8$Zc7- z`hT41qM!BDP%WA>O4S=d-BOEWTn!jnT}6LqMPc1JvK7wYt%2lx&N`viOJLrM7su#5 zE>NnIQd-Bt3E%#BY-Y$A+j_lp`^-%GD+&zG--CUFd<)=zfO7Ln;4NLiwwB;D3)#|` zXm@Ee3IxFto{f8|%QZe&o-K2dbTjrT+91ri9(_wCEHVkh%8{C9tWB~juE*-yoE)TA z2mA`vbeOzMSiFt9I-Lz0It@I&4L{HWz5eSiW`9U*+%tBfO`MrWp5)lJn= z4p1;MwzZ=3w^T?=7x^pwg*+ zoVBuf$YkeV>ereo9t+Hs{e6P~UK~D6@M z`q6P4uKv*--su<%G#@=cj!M`i4K*r!hES=DNk?J(jE^!5p>U|nu|5y8j&%d6s_eJ3 zD#WwB9wxpnh>&I6LcYW!A|m{^nYhZ-yBdic+2mLJk<(4AI6CE()5X}H?b@CvTGZ`j z9dBaZ7&}4kZGCTO3)kyC*KXeK?GEoFE8q3|N!qdUtedILgtz|Q=cdL13lqQ4(L0Ku zaeG?92tPvk!0>g3V0a1fopjlfj^GrX3%tz(o(qi8hGc_yIr6KG(yeVi za;tRqyYer7=r1qhA!dGdcp(?^%f7urIbR^Z?(4Mw>&zD9L>-YwEf7VY>^s(3%h$F73%m`C4v z+KbBMrFZK{wY)w{IoKmDuN?3+X}HLjU>-Ewk0MkHct~u7@9>#l*?{l@BM1{?cxV%o zXv5fegLCs}gM*V}nX{9rsl&<1(*ux#l0sUllA@BTx~j6$+PV@eyTU@ta*NB-qO05D z`|IlxEd0{)QvBj_yv%$I^9&vRECWM*C=-J%vz;wtO_r zF+Y!qqlu5Nv(wqxqw_Byryf0a6eK7RA;KR7e{5g~(Z>&o94Pt#a`6X{jU0jg1ljl_ z$j6UDM2aklG6+f`ELjc_@^XmGnL~)wv`HkV&YVSh66sl_Lr|eaI~YA`q=*rtOPe}v zdZfb^SlQ$CD>VW&q&OHO<(vb=#(Gks{FFN|PgJ&Rn_G z>d*ne1*inr^gk%yBC7GmBk1NFlQ;;v&L{m;R-L#WVKrI>6P(vNXlu}4F)d5vbSyfe4 zS4p*1mtKAOl~-kzbrxG}xz!e2a;-_%T}|Z0SDb^*dDvo#CH7dJja5cjpA1}P*<_h< zR*fMA5~v$Ejd-(7Io>3gnj?|0hR!+1#b%6s$iP5Pr}SvksHEw*gPkQ85(khDuO;_O zGR$$x0U^;%M^0~&kXngw-F;`=c;uPK3VN`pM~f}(@d6*F^!~}l>~hKI=S*{i{0B{R zh=SHlBjO~;h-wU?<6yWD$|K_+m{>B;g_>x%PbWO2`VYJSZScoI1Q}E!iYNXcqYo`k z>w1ZH{b=QAzgIaas1}7Z50P)HL0IbSZpR3P!nj5X-Sl7-yq~^0L+To3N z3b3gNOKdFc9gA!)$o?WsefPDUDYVb^N9{9)47gc={@BXREv4VOQ#U2>T!Joz=k6e( zjQVV7ws)$d8W2JBmY8o3D-zVNL@nMP;~yFoywQz3>d2#yKDGoTkVMXe)5H{C%%sLe zZJg9nOjSv}l^$bRvdJfd38u;`n}wFkOQac>5;D`Zgj`IlZ}ZJJ>s;rZb^08%WJ6mf zS6CO1RI6Kc?jHEaL5I**obdFmJbrscdWbc+W5q{V^SKW)8b=%bKyF%* zvzFz!5h`(Pi#k=?Tsu04L3GJzblRa%COEMEgLGlBAM@}I2R=cM5P_&u0oect%(xJO z_+Vc>=ody@)FKW5fnPA{RPSQMFAj_(2%bub9_Jwh4iGPp9EjM&Bvu59Sqvx{dmfac zH$A6#?0Q_{(w4NR6_lmydrbgKCta47x0ug-GD~0j?7}|1>BLAXe z9_8pwjzE+`BB7`^d$iIL#$*T-jhK;evOMN7sgWD2QpYCw6p>ZMl9t5eRZzyg?}a5T zN%-Vi&@{fNMm1)pyvzEQ04JTbQZe%DYAj`WKR*>MP(~Y+(z4;d17!<^!W8B=R5Q1@ zPO6}hKxX572tf&Qg9F}xtAnZ&&1g<@gVqEHD6;u1+VCejC8S3RaWIJo-EBKBwB{## z0Du{$qMfUFCk~Az&%-GzIX`6Fv-GL8$VtwKhC-qN!O6rXwuT*&^<1eII=WM(tD+S3 zV!3!Q4<7u1S28M&jCkM!m;SDC9w%zZis(qvfK6mzE>)=>^B9Cbn50}Mk&#N~F@!(R zR7NjxDe{t+Q|2+RkxzPL$3P}YDourCT%w9mld4oQwd^dNY{FCh8&y)S$&_`uDig4( zO82qSm4|tyo`4p#q4|ldm-!Pem*$!2u$55;?5hmm>WFhtjjlLQn=bOROl}&&Q=R(5 z+|+T2gkGp1`>3WhubH^SDkHC&@su|?5KhPn*>2_3$2rld#!&Qa$?mivJVEQ8!-;lT z_N0%qg4m3Gs&;bCTpHL=I8529gSNHJ;5|Z@+tXQ;LKCg1MUM+y3R(7xZLC+ERiwt^ zLZrEMp2!;oR!0im{*jN`Qzr<^R=&* zimE*&95tz8`retE+LloUn84;kpZaEY;JhsOeeh%OR~ci!T>nYJ6^=}1{zoAH1#}S{ z9$+v{^WjIC1F{Mf^Ozavz)dl8#S!INxg7D=?8sPG!y(AoMug+~Fz0d5p*B6b#)yqN zD6$Ei>?V$!PHXFp50!trofKD2UT9k(CVuJ)h0*%oXSMAs*l*>3P4r-aO< zu6D_Yi(h>6aN`{B?;Q8I$yE_@{iWyT2F#5Y!N?qCl)D zq$lkYMq0Z5y&RL?$DR_hsR&(5_vOk_^BWeYs>Lj5@^7lA>X!7my1=l;OM(|%YX`#; z*FTdmEq7f@qwVini8>Hz+G-j{MM|y;bYh9colhRGm_jm;(KhB0P8feKSHdaC22+(z zg{X}=T8p5$yB0NyHYl>>WT81dfnQGW$2Vk-5@T;}xjt4ZooHRXZdU*N3L ziBA5u);ia{UO%wsuh+gtROx%ED8=Sh$yPuGh(HOHaMtm5j|X}2Mj}6;WSoTx=`k$okwc(G zPnbeli{mWD0C3y1Wvumo1~*U$L}DxCISfZ+XC@)KHE|QiMJ04`7?*osG+f11XCDW0 zDgu1_0$m_6M;d{0D0eU{w|p+wHH5|zG6FFWIXAXH+8U9byl}kS$Au(1T?cmVHDPDzm`iA1S(8Z8o=aX1^8hh#{O(` zRZ!XXf%w#b4)`@OKv5F-2Xu1-po4*=GaT~A!W%zWt>NfKKOZ%6FH;D8I@>)V3s+l5sC_zgsewo=aMd)kVWOPX6JNn zQy5%7kkW~3Ct?XGimxJf*Dw#DF@ZK9BNo((7kEWxL=WwfdjCng z8ZTx+F*Z(Sv;k6SHXBHbMwwYPbVHY?LsJ$TJ9tk$2yl-haMprhQFCx|b%gAIP%`G0 z4o5mVP&%+Dj^nsG=Y}@)@Cm?GE*&R3$;FNx$Atm2F9Rc8Dpg1GaF5(|hT{cud_++& zL0-{UQ*elLiKKIN=tw=6knpvTmo!vGXLLs(eiB(0N_QrqL_Tj}7gR-H@W+uHDStcz zl3V995C&GchCda?CnuSb1_FSX2sNc)fCMEeZO0(lMhQsi94f{ccNc+pr+Dk&ilxH= zIp8%xc@RY@a+no@xF|ukkqs|qE82zw^socjd5$oo5H8|@E5KR)HdKSN5Kp0HILf$r zJQ!{I1bV6^jg_;KrzbUQ2?;yU4h^@2aLFCkS&nV?E)U9=Qy6DHRxcgJ0e{&kKA<81 z1CJ~=5A+yl6xveS#e6LWUjGOaGf|o7wLFyOJUkaAnZ|uWwTBFO6+{-_yh#nb|wwWi8C{|=8i6>cByX0EIiFQ!KiQV#&BPNr8)rtTBjng)b z+CU)^=u&_cSQEl#-Qi8Gvk(9SgZ=@gnxT^(IuGE|lkkA1=Ax#y5h8}wo)G~6t`IDL z6F9|^Z@VBLqs1&?xu1>$gheETmIG#KX@uFxme(;(33~o!uo#yv_irr7xhahW&Y@lk5TMj_>;HHiq> z0IUCMfzfoGR^&pJC0umYrbY>aO!iLmX{d*KpQ4qYjOuw=)}PU+lv0`~+JYdcXQ>6+ zIgKZ?X-2T^G8~)`i@-=xb7p6`Mr1_BL*P}lAR22y`=W}4(`hG^r1mCI`NSdVd(xz=Vxsp(0rQ5)XeVe7lWT~xKHwzmLq^Au)Mo@MdW1mw|6iHypKIKWU^V)=taL@j2ilGCw^Oq6ipasvix zH=3%T=Hx;*i?ia+Xe-;$+qDtu8nw` z_}6Q;1f@`#l2n?B$Ywx&yLR(huWpBg__|L<#58!vixC@GE`-4r%PXMkT<$r!&S5Qy zup64g0Tzrwa*4ukrk6J+d2aeISqV79q5`JN9><7`AqztHLQdI!i|i|=Hio@;6hzwZC`Yi0K+1a8^cfbvG%E`Yg1bP_PPR>vMPHy2tvdm=4^_K z#Jt;$>XHe;+b*6k5W~wgQoNUui?CPhFBl=TCigESWwanM5=h%}y4n&m=P*w@Q#8Rf zQ%jJ=`l6c|qsnT&G|GpUbYIe1YIHm%s5!P|8>IA$N*Osbd;G_1n@S8;n}i%;5yqtY zbI1d{$e=>Ii&BIJNXa55WUWzwT$;)3K)Fh3dUHyri;KYo>r$|as=K_)AN&G8a1=(LwbDQ}W@#UZuI(0QcJl~tf zOOk!$ixgSwnft81MkQ)=Y?@@jqwrgi*-F3aQ@^KVV110g`g^2a<-dCpw@r%37H!cO zfEkPouf|5H#yMhDW68E6HiBD$zyTayD#4cv$`5NU@nFhrCZXR^#kS+Y^LSyF8!F{; z13MYq*SUAUJI!k*s(FcLva{CG)yhOII5TX+Ik*dolVkcx%=~H0vRitSy3rLpTdJL@ znJTm8?agXE&hi+ByQsNwxIMUYCZD z%letv18PRazW;oFEF;kJt0s+o(D!>_3eC`zO#*>jYf8E&T*st!8+M8er5FGJp)thB z_T6e%+M_ZFc8bY@3kg}>+b1-_;9Z?74ZLuMHlT~Dy6oHN$mnwzBZd@T5aRh{+Y4>^<@GYVlo-ywI#D$oeAfiflb^Y z0s(m1?6b(#&C2V0^1aqtJdeEN5jc`Cb3NB~EhKmyY4Qxd&C}PMiO)gxeK#7%rAdD6 zTdge9{#28$nn2pvZGuW1SzwZV;cL4DB#_|%@R66D*>Zcxy(!`Y?Ae}O;-vA&Ejdu$ zvf`D3+Svx<5Ry`FNg<34reG9%|<;Y>(R>su%!xBzAbHx)e98i4&$rIsQ&&XQf%St`- zC3I53@%=n%5eex_m2{NeR1jX!rIhKg>8*8v;cE-(SrtE*Ezw~`(dx?Cf3oVWE)pr%|VnFh#DH z!N5yQXfhU?&5Y@ShgQ0+fQFkjjrCZE?X%KQh^4V)#QB- zXkKL8W)MwGV+8?)aMlA?*t0%u#l82A-+U3eV^Vqk)_hJ9e$FttDiaM4tc65Ky)HBdOV_E_SJo z^9-=+pUqYWT!cobrQt2~PjsNGcMn*P^pW6Fpi>XOPL8Nd&JqEJ8etN+gzWyc%k?EZ z+@-U*PXF{9>{1*`_40@?Xa8hf$qQ@$m0BL|$WY8>3B=9>2r)J`f`f*KHaCMejE#;r zI5#bHprJjWIyjJU+EOxIVeBKE1s_KES{} zKg6#;$Uw@=KtaksLC(?B(LzDi*g-?u+(Sb`-`+#7Lqy|$=0!y7>_zTG?nNE)^YtC~ z_(nxW_x%3<0FM|ENU+0^g9sBUOma}kkt7fwLY$aH$;2iVm1u0zWTO&}AeS@|NpcC3 zCQMSMM5!_*i6tbM#3VtpCIA2n6fDTebEnUr3m5r%Oq70G-RsNc^sne$nFhq?C zKn5WjRf%v1iYu1p%<4wd>a` zV#|)*f<^7xE?Vf;ox6pL-@t#raPgwJapN#vz;FShxpU_-V8ERYcdm80bO#lxyY;K1 zu#YBPQaip=B~G3~f#M-*hmKRGcF;1+ibpJ0tZeDRwaW+NUyTKWjDW{P#tbt-Kr;;x z)=-lTHrse31UTUcVU9Piurm%j9Ig}3hw{)v4?g|ulaD_g{urTRiUX;r;t>WZBx6Dj zF%(ga6j5YR5*TUZBSsu;1ky-EmLyV2OC;G+OEkeGQ%yGEG}M$s8Aa5UO)Z7gQdvUP zlvH3&Rh3m(l}YARTy>Smn%;?J)|-$pvetNg?Uln@SH;C0czEfx)}J}N5?E-3(f6M& zz7!)2Gm#0wAP@i$V%eUU$!VuzpSefqdps=Wsi&wJ7!8B0z2;gAE1;@ss9yCzIGcI(HjWivzK2^1!kn#X;rKtim=J1SdPHSma>-2S?5|n6KhwTeg4_k zCx30)3Vr(3Ld@3&B7=-H%?N=fT}2O4>C;bt0ve$`q|!<+Js`>f*kVJbjHAw&ZK|m( ztPpssw-Fwzth5TJIIhSQ$18Nw`Ko8I*l9O3(R_M`8Cr5$a<#P3N;~Z*?Cnr`eC(y3 zN@82jM~k?L9aguwyl5NyALthNO1pU-rcD05vC})vE4|Yjj<&=P5xh5lAXbjR9D*3n z!3mehPd^O<#3IElQd}`Y4jqA`#yLW?V~;+5B;-d!j%=jKD969#Oi#8P<;+#?WMxtM zGqokpJPVTmF;JC5oau5!152CSbe1?>!huXvi=FHQw8~Ab5q;qRUvhvoK@nm{8Ox

RKurGsp8)4!$3&z}{ZtG%9-jeYyXMCenrc%{xZj-85!74XM zq}6bi$T-J2?s3kMTy-dy9n06Xc+IMz)Rj1T1>*n4XC2 zkuZH+4@E1=h7jjsYnn9Z4mR+E=8JlnhDnOBs`xWIqx(;U+tY z8UFHTGyQQ%XGj5HQUn+ksYJ?xhq$6w)`SCQW)6d7dDGG=5y8Dk!YxuO+UBl#n6-2; zF&_k>D@r3Sy@_p9eN$l-4Y9UvHp^{;+Elp6IU3xVaBL1zVGvt`D%sS=Rfa>{Zj>0D zCguu?Fo=#6trHhvO$trLTA=1I$gD^>%{EZ1NIgLN={wp!qAjiJQkr#1b$Q+Ag2lS+8ut`?Wk|)aE!yp!;iG7kr z50Qu{%U4Q>pf7!@3|TAR2TPO4G9^xMN&RX`0$lFWm%YRi&i*G%rw|iNKRc5$5s@~d zDWaLpOxjtbX_haB(M~%U6AKwZ&(eewguVFGV$>BGd3B>IF-Ra;lD3!T{V9fG5ZbGSPVqX1m@DS^v_*ONPVq^t6aiA-i0 z)>=BDtT@r-l#b#{w5nB0IO~!y-wM|P9x$Ru3k!J2GFc2lBAO3mR-Dper)%B`qG~fs zW;*LB!idvrb>jgEzs6X|fObOMC?FOo8>qs{^F7|0qX>6=PZUmL8!8-}X<6mZfZhg) ztDV&gUi(^G8T5%zRH)>Dbsb?z4aAS=EhCmTO)mzQgPIWIv^Z+U8&}H|8vs}9^!y6v z&MuC50UK!;tKIApvWI}|ZVImfUU2NRc|9eEPZ?=m^-`LsMSXAeQnaw_DHUQ5BZz*% z*AS^vwW|IB#_C5_$x8Pn34UHx*@6|^;Fdj@CT2bB{&wxZoc;2bUV3XWi%CGC4NbBN zOfy~~$mRwLbn?AxX_E4a|&pq$A_ z=dBqxxp8amw`!46{h+jYIwVFh6jPuawo8xNZAOB)>)r5zH$penR=>uuA9`lUh3%!n>rfg?IgH4Yzfe zKK>gv2F6}&LwtC*$zHf#m#wrEtJpIWba7y*{iZ9)`6ba4!@3CM)<7PmHrQ18~QLg5m*Um3iL+d=cO zsJ2(n(aAia<3w?ddvS4^Lfs{eg>&%(M-kR@gm$!U$qS8gdMPN7ffS_6%?l3k+U{R9 zCvT%f=rxk+(f@1JjHnu9ttQ!#Vky5_Qk@C4e(bb z?`Hk;wf>y~Y`2CTuEaKWLUwkTlSM~^G|bj|W$|0p^jCAoPRj-fm31jJwr&1_{wU|> zWT7Q)-ViBmQWkd7EJZdN+O{?CF;94>E(;P~97uVCb9q*#Z=B~^{)Q{DHCwbLMUzuz zsi#|O!dnctW)CzcMCgFRMMhbsFnMuv9>M`d@CP44Jw2x|mxM_G!Bi4+5a0Jnp@ek)m2~BY zK1`=oTV-HTcQOh#YqLfZ@YjenA%9q>Yd(=yYn5UB7i|9rS7b*(2=s#sM|h90fYG#9 z6~#Hxc5Q=q2_RNkX9(NaDqMlz*&l=Any`* z6yk!H=K`(L8#2fnv(kB>7jUwLP-5mQWY$o_;)4aadYdzZ6~#fy0*;3#aTI4p7srHl zh6@|uEx3Rmaa2R3aXWYukGR8yTgW?K7=~Z?UFOvd(x*s}#uEjXT7ZO|bY6$jKiZ~Nc5>_G!f3{>x_4gB$s8+p{VPE%u zKBI|b*8tN-fS!1OpvZ7|rD6++3C|Xe4mfQKxK~yKPckGoh=nM!NJ2X#FB@2f;^2We z8G_zqJE3tHH}*z$6LRK+PorXtK2>k0^-r;(jGD((m{% zsCM0GQFP)>J&A3^HD`5}I>=>b_EA#$0WP@kAB^ECiKUdp;3)>840_}Yj~NY%Aup4O zFUsR+07-M_Km?w`A&Q|6)+dLX#%Y(NR1QOQo#Z{E7D`7)N);K1s3c$nwvn+`n_?wa zROevu=LC>=OHzW8yu?4j1WY>vKpYl;W5)n831W7Yc1Xil4pfS4;aAtjL6K5zcd1c1 zpl;fxMzQF4O$H4;%(!{26^%?} zP&pU_r8gZ6-k;`8j%dc(Zq0Oo)z6X#O9{l^?f&C|)B%BP4RcAaYH1 zAd(@TjztaIz=GNkc;E17KD9{Y;7E{E1a1h29RLs5r;yq=UrU9Dq6U8a#Sr5Mh*$L^ zt2UdiwtlubKOad}w$zC7=bKcLl3ape7}k<534oipiOZQLU?E}>^_aHbb}~N#sQEKFVbL)$Jl`;CY9;oLEX76{DBL_05<02V+%r`^;uuiCrG$P7n6iKisSpd$H7**uW3%X? zd2=An0H`YmZsElZ_%b08(l6(rnVV@29pWMH{&0|*HitfEA~?#B_63po^;CU0N2$RDO6<2_xVeb-Gk?61AFPdI0)3)o6MKCl_a?rI~}Ems*OM0B1+Imt}ND=Lo7>b07RMT^^^Q z8){uVc26MsJ0hxbjs<1aaH3^MAp$vRLA9#{6QlD0U%*P5K6jd+25LoDYX0S#I%1I* znN`qQr0X}W?q{uJHImu-V7Z2WWSf8f_qQ|R+B3&_rB|AzbXAjDw5~YGuD`{TrWi(W z7g!88u+#F2?wAX*I1G7_g*5dFa!LfpxDEi&2zCk>q>y(9d#`)irf#~g!PBqeb|K!N z4q#b0`j%Q2d$9#2jg8YBj>;=KIG~l2ddD`G6D5RpDT2;&ZAXZNEbEsM3aT(Gs==rq zf3{>_<9Nb=v#cr^^5$3#0%XlsA($xyicxdsfDSI&4(bpOaA+_*w`o78NvGLK_oatX z%bKG^RRHF!1D3Vwmol+-n;$t=SI3*S)TAc~oGHnFUiWot%eFDe0Ox8nTzY^A*seS2 zuHkqd1PfS!br-C-m-4h{d)oe?zW`GV3trr1jGF7Bi_12x_z9wscZLyYfa`99t1XFk z4gPwJ>OcgY>rbkcpS{s}T?TNZiz_kk0yVrVq*rh}h$gI?a3dRp32L$odcY3Km$dh( z5(=2@xTkOQyTCgjEX7zn1fna~Lp=LrCJJ*w8xH5yqU$id)C&&**+M8j^o48cA_!p(UR-9=oY{{v=Sn9UMVv}+^ zw*Xi`r@sQcpzrFF)%ghldrczPw{W9(T=Tn&l0%U}!Z3BhHJ8GR3n+CG7;M4&WJE12P&ED+!!xWLqG!XWyRoTzTNV_Ta#^W$={ZCBG~^g(whN&a z=d!gBn1RW}xp1lwte7WcLR6d@SKPBdJFB$Xyj|=_UTn10JI2_XkaUQ~pQgs1w1<3n zG0IA{I_jK7&!u2@QT{o9-X9Kg{DreTT+ z1zf;m8W;&IyPUd?seG>;Dhvc-M_;HdnLBA50ss?q%Aav=i!m42GMz76J|) zqPVCfgR8|_&qy4vRf8Jq%TW|L0XjveXE~Si&?M`P6?L*sEjs0RyB?LqplS=$%pWw{ zrvL&B;n|q1ib9B%y#82>FF-5KT`bFB%&TJTUg}JT!uk)N29Zv+qu(QurbdzHV}5hY zY8t7vcg(d@m!y0A&wZS&W<}6v3$9cOcKM6QF`1=zwM<=#G}P2=(n-;g>^6217zB&b zvfH;Ttr#^M!FnT*gk(FkdR}W?#wfi(nNpM%c%iKP$s#R=BrRGO+#wxMZ_T*V_}SA) zq^P?*TS6@z#toou*-&taaOi5x4Tq_CImsxCgcXOxRc#;9eAP}IyyybbA6mS>gJ{Uh z4b>11Ct4xn{Kc|7Fy~xUleDx z@T;wVTwyDj{@5Cpwv7Ff3LTRe&;S$8iFKu}jVy$uXt$fdH0SZ*7A;2BNw4*qcw1Ad zqs=H|qZrkIQ*#>29C8ny-HL+(xp*f+T>Tg!ZQFT~+9oZ=G7c-C3mm?!IBFTxH{2`7 zt;5*3y3GByX$Hh4+tfpRcq(g-&it3q+%?*5%{=ze@j1m`tr}#$Xbln}^M>AMP0mFC z#*u{1N~^v5U`aTtR1itm`W1c|gV$DjetccWe$9RBeUQnudebq=n! z3GLWz+W?TAt`AMw5xrs?j@cgm;RlS-BmPd9?29KpJ4vak@+mxw=9H6m&h^mRFyxAx zRT$^~7QBnH4A8*h*Wlu39pkJWQ2E9i{N``F{6xi#+)HkawSlTmL#lmPTxy) z=kQ!H$=YAbS`qtg&;8xk>8ld!n~3de=>HtQiLU5~J;=mqzZ(|mj!oed-vG+FxRyTI z>zZO7&NQ43;+}rMM63fdKI$fZL%HzM*&K#sXhbMRnD2H@^O8a@ z@8jhRsjk z%xckdqMLhh*(&CH#>&wJ{Hsc^76gT4zo|opu2Ab zrKoG^L`jb9$j#(VUKhHhaIYK0pRLT}X!@9ZMq7XFx+~4T`<-FWr(r)ryZ_OvD(>M; z?haz^95{KH`LFDr4%7SQnT9Y+OXu}&hdD|RL|1g;o8N$tBsi!v*pzgrr2f>jxY+av zxzr>{xn#+Nxx}Q2*~vum8A>urT1w({dg`>w+PeA#0I(9}yNmk^42;1r zTx^VioQ&Ln!Q9Zm@XP>kV`Ec|eSNdd-R*s|vmHJTUQWJ~Gmf5~!=AnazoP?y6CbaG zpWmai&*Reru!oNy0|);20R-WXAPhPD`6DD^#32rc3?YIsV}}k!if{w~FNY41`S9^L ziPFcvl@1F6d3kVQ5DpF@28l@1;>C*@J#zF|1VD?SEL^x~anz_%r7w)WcnUS@3m8WM;z1ku^L zwN8sfcn&F&u_qDS9eeu(x-s}hBSnZC>2N%`k>$vj8#&V9$n)q&s$0K)UCEIo+qr8W z1YS@fL`f8xZ*&M!q)F^8S!%K={t{50K-vFf$`q>ouKGK9;zTUB*usl1yZF*eFv1YS zpfSWK1EDg{O!y1{)>MOoTHkyVPC47S<)K@2onsC-?x2HWJnewg7hwAE!%sjf5kzBV z2Qd_yLlR9y(I2$+#8HsNfg}=1B_-z1KL8En5J8-IhGR|sJGNHQj~W3tWD7+ZHPlc` zIR&OvP{A;jRaI$~RaahZCBs)|i6vHAX;rfpHaCEHXIyjL#phn_w6j;BE%sH?k%l3O z(qfJI^O%y7O-7kzn$fr!5Sw`hT4@QD#_4IErUvRwQw|Xusk70xQ*A}u))Q~LbtL3Q zJ_$Emal~AACtY&Y1(%;n=Ot*1e`Rb^K8PmD7^9KN z2q|WjU1pgt?y%Si_v z;K63MU9m?LQY?7mC2}5mh&20bCGW|%34NX1XCJntXv?iD-UcWOxdfJbZs`r4j?9DX zLP%lj@?tpjhWN_m4LSAPdvCw&jMQQdECM_*j0US@sY{*R$SDvwalm85f6R?r2Nc6< z9L9wr$?=j1J9PY}VmmAm#1*+Z{ZDxtA^w!hUA`Q%Q8dq7vzch-9K%=k!&z3GKnG1{ zH*LM8C%DXIE`ItGitsY1dz1t)gK6N@7E?9HI7&%bD~O~H!Zpow25g!NjR#AUnoq4p zRHHJLY-UrN6y9cqym3|CW(6Et8Aor)*%fn~)2m+%E?C1doUz1%EXFO%5s+)oB%+mx z_*CmY*V0@n_|v&p{AU#cqQ&UMWuOF^4s{Pw9lM;-3~0csLfNnZp6u0)9MH~oxI5qh z4d{*{{VQPb=z)s}CcJ=ffJrprK=)+AsU7vPj}Ms`%FfpTkYo&d6C?MAlO1P8XS3wY-U5-YfOkLRHblY80ih&u=Jbb$nbp1+10K9 zm&3sAusYxI;SYhBti~LUybX}`k zM(bRcjSQi2b{$fq8uKNWKS@+C6y;s-Kw?K12`@$fp@|Rv;DegbL?JRE&6I@jkd!_T zdeSqWagYN5T_PrX2iuHFniR6+338A%spiSBl$|;R6)!bBqqevAVN5}kdlgUgv}(` z+E6%6p5#VuEqr0c?xsy{3KoYr6eo4YX`LPpB5{ffVtLR*#C96dJ=BWlJgsHVdq$BJ zpZm|Zu1GEgnM*+e?P5XQ6~<_Y5uvd|V;a{ejy6to9VdE+J#0G<9cUDf1?%WTLdv}# z;FMt}J(XTDa>$p$^m>TlsdEXbu+u1SN-8a6ZcwJlpmLI^MLlX#VYXBmKxP)VaTc|tNn5%S)-H%+xoS)9#d={3?VaDQ>p};ifyTy z=EPj+*F)Y7IfMQsta8FBPQ;dTvFAi5K_qoxVo=09< zy(4X`x?D~v@(Nr+yz-`{)I%itlES`Eepi&?9j{hSSwFC-(gyqE--X(n)jbW+E)uOJ zST%Y*!t?`45M0zsAd^-LCd@{a;vh_vxy-WBwYYc1Yl9yQVZX*uI5pgr-YDF+Pzw&R zi7gz5J6wpyK~}^grmVD-SRZTQ$B8T6Y-gW<>lb5Di@+FdFlbCr*12o7s?BjXGIT}} zZOEZ*H2z1Qi`*~W{;MxBeGzXVBV3RQw@D5A192nL zlCTd-B<9}eSv|H#=WW~Dfef=w3~6OE@2c9^Lo}sqG~CrC^OZmC900(KyG&U# z{!>SZ)bZjB&Zz_%{^~rZJ69d62alxy`_xrHef7_PhB!*jUDgQpa)SL;E5a77!2!Rd zQy{0S$iug`+BEpmd(AYgely`38pk<+|64c@OKMY_^PGkF@Tx`ZPFE+9T9>2e(6LqP zd`=PRx#njUc>&M`4b+Pf0wcVN-8u)v%U;S>HaD0(jv>$1UvfM$Sd+|Kjsiq8z^%#J z**;y8&BleX%5HFQ2mpw}F*BlZ$MbFa_jcDMZ`svyXGVBP)f9;r6%y!Xi|23Yg@M)p zd1yg!M3ZMo!)LTKUk6P&K?HK{S+!g=-(Q}Jgo7^E3qh7b>dBU8cwI`M8C zAS6L`VapMK8-r-Y<0P3OT_EIk7QugUhh;+u058x2_Qn(u2wsWDiA~jS<`rjimVtIw zCkB@%mbX=W7KbA^C}MReh=C8+MsX{6acVUgmV%3Gg?E{RL!jn+f^&r9q*yeEYUSaCL&Pjm2rZYeeAR+k^rT`%XKVh`$A!5D1y#gr zz6OS<6KoPPY^nu*;nx5TaE1j}em&L=Lgs95NLy~SFVof{x&;7sh;764RwD&Sp>a|u zr4xMj2OKePLx=>2m=fvcBmkRTv7-2YuqGg)LT&Q1D`2 z_=UgbbnW;>Wk@07HzD;H7x%b^Zs<^h$&c*U7w#93J1~%WH2#0Y1Ym>YZ8U)zQzCmQ z1#D)>|hPq>z?|_)CsF=d_ooF*G{@Ickh+gVtXWlTA2nQFj0Hi@G zq(e%iMQWr+ilj-Zq)W=AP3oji3Z+phrBh0!RobMymVHhqhENBfdl{f)gmr*menu=$mY!Zs2sH3FlKd+>lde&6{fC48FswjX0DL|^EngXVp zs;im;D$uGbpaLrZt1CdOwaNmwdaGJO6kWorgvXjOx^Fegcx^(g`*Q;_;993h7enSo z0;6SQb)0E+cN^D1%44lUkblLMfIESxJ9v!#nq-x_M}&PkI7ncw=V~nGiF3*#VoY#E zB*u-g_MRkwjxYvLz{Y*T<_!OdV|@7x;zy5Yh-`Ji4YSjRT*s_u%AjbPKs>pacephd zlx+*)5TYRjbgH2zgb_4B1bO0GsQkx7D_HnnXuk#~+rnI%UAc-jGa8m=u0 zqDB=;V?v{zD4VmHUbSf!8(0<{*rTX8O8{^JM~k#a8>*&yswcpzsp_h(ngX&4tFv0G zD}bw6tE()~t6ox6QlV7B3W{!0tozd@1sAjg3WDo*K+*<05N8;QBDVr@vXe2b&8d`} zVPIwRh{jcn*a^7A!D)Cigcb%Y=ZgNgh?}me#%k~yuR>Q(q`*)5xu5KqudCCg^5_5< zAbwPrb$^*BYP5Cxn4sujWOGO;Ybuau_okjvu`}UqH~|qFd#4W(vktKl4xvpn3!?m0 zQ`=J$f4~6;xFd%8BOL3oAWMk6D;<@{nqtCKDyg&dbE!Pzvl@7trO2tLxSN<~v`D+O zN6WOQ`n0e5sq7PwZ7UuqU4EiR<^5jXRYxo1W0hfNH89RV4m#CYLvx%@(PaGGP%8W zua?`N?>I&W1+bj!!U0=;X8vR}3g=^l`E~vnb`6@k4ts|e1Yl0q5V0FECzOD@fx91z zyD|HahKn5&X?GUnM-Oo$!^@E^Tf{YSyAP?v+|)Ns?7YAVwv@WFYl5S1LRGCadG1BD zHt9P_o3!Iws^uHCt-1nJJGJV&zU=G1UCTb9L^JcNCICmQFsUK*QhsZzu(~B}i}Z?& z5hLl?Xd~Uhhnpq zE%b_?SV~%VdAWJnrT#jPFFbyS{FlF6!|G>II{asfthx^x5P0~*2T4eTG@5vo5lI{| z$bq}e>!K6MUw7AS{y9~#g(@3+b;Q%W#Y}u1=IXpkH8U$ozb=_SXFM;PN_pJtsa%B) z-y6P8d#b4Vv{g&TQ;WV=ORMb5wFCXWX$C)l9LTDasfFwf`K!MM#IQ!fTql8o5L%0B zg?f~{DKCM*H*u{C2^+&$jNeKev%;bc=!{(~9Y|0ehRbwc)@A|)(=tqX}Z`v-}b2Dm;L99fB#;~I0-L9*uh(xr^S=wu$~*$7G? z3G9&x?CGBQp)HfEjsa!MV@QU%yvs$+xdBQIqD!zKSR(4zj|&S9sC&%DJk@UMm{)DB z48dhNsDQVN#m+;n*5TV!eRq{IvC4$85n;T=*wxOH#nz0ta}7UbV%KIO17lphQngBa z{myvSsh7u9c;P#v>a-~^;S;{kuu8|SN~`{y$66cNy=u@C$W(5Y(AMBHRb|Mqgf!2_ zzy1FEd5#MIA5LJ;N*BhGi;IBSBGU?x5nWQGTwA zR~?9hlz@mTVT9YFqAb=i?dO!zJ+HeE7dz<2OHDuF5qEwZdF~v04&UgS1OOgh@e}E# zw9cZq(2=LTn*LtAd6Vow*!T?Ua*W}#s^O)Mt600WTr1h##bz@~shMr!gv{CT9Oju< z@9qaR6g?QdCF7^9aRr>Wn&Q!ytgWO%jNSUJK($TF>x{YG#4ZZcU&+Bsj*T@fIZ&RK zn(*zKMMdC}eOR95D!f`;PTlNY)D94^HL0wbH>T?c(dzIo#2nh<9T*4S{^km?dJd^l zZ-ZQYWSYB6vm|@X7_aXM(;5BVM^PE@6xOIDJIahM2pZpJ9-k&KP~iTi*N=zk@T|sK zm2iDF*r>Ylay;t)%;C1`;i}$AHh+>ME`Px@%EPxHT`G3!zz>{^dn&R-m||4AAh? zT$;JM{Pxpr-3|@!15}t|*Q}g}?}~gRkKY3t2?#(xKte!4heJV$LyV0>MMOl99UVn~ ze;k>VMjb|;o=2faNTWzerb(#)KR!RML9RcCm$bFELy@^1nH-h=oSdDXprb~lNXMwE zFfYq6E-=v1(J|97GB7dOGBMjWG2Y-d;xgjp<~QOu>geh?>p1W?Iq>uIJ2*M_JNf$n zDE|Oc2ppI~ML`t^6Czx}upx_w4_mBg!GdCoix^#K-1x%9i;vAfN*f8y1`LznzI`*7 z&IUVoH(=(736EZmoBML^*vV6e&!0MY@Cd4-htZ-&lN$BGv?(iAf?~M>LX~O|Lsf-n zB}7Q8SFMeN5MeYnSFR#x(-x`Zi;`PlzdUsccEre$4x;jgN^*p6s=lcLCux#IiIT#G zn<#10WJ%-3OCm>RLb);tCYLjl*u2>Z3C~VKe+B@6f$9F!rW>5bzyO15)~{o~Zh(Py z1J$<~+}_Rmwu1%^Fa-ZSoOlBOGixfhS?{LvoX_*!(7BTz&+9#R=+LemXixyHrVbj! z^^l_Tjv7JIwRSBfOuU5I6=fIMvA{}Jg^y*({GqQxq=$=Hlvn~^FLTL9pE0J~mr8!i zfW!<**kF?lHP%?e4L9AWB#wtHmBY?DBf>WRg{8DG5tx##v{dbrxD^q@gCNZmpFHn{24M*4wJQ5hvWMt~y|x0{~cg zC39Hf#9}_yUDqpi*=;9mci!!wpLl{`W!@r+2#A&>MDU5$Tpe7(3kUOwg3KxSslwlQ zhXBFBe{!a`ULo>LCO^2A&d zi_if}Y?niMdDNInmFWWzt^EA6R8?7p{*@tbzDaJJVcCi2S$d}1=bs6FLYG~56`Ge{ zTq{Z#qm3%|=%bKPI+>-IrM)R^8z)rQ;NtNymzaKZr>IB~xL z;Lfcp+5<7oH|Zc<&05+VEO%V`#KS67jc1jAi(KnD2f9Q%EnIf7y2DkH0JSi%dxUP{)9MHuD zWsKuO9D8h0MIjG4a!2Gx=*+z;GZ_v_14}98;p)sJf3DP1#}f}XTOMYZJTK+5(8(HF znyexVtQ6vaaEcS1=7fto-N`KedYTqnNC&961gb7r(^{hZ0vJUNrZ9+EjA9x?wz5$Q zQ&q7yw z*78MQ1S5BODPuA~n8x!7&qBmAo`<+m4&^N`9nFi$^H4+&d@!s<(1E0}QXr!lWltdr z;aJCdL=lLDY-AcCpM-)(5)73@eI7bV`_KUoDk(C0naEN;GI1UJ;qNCxA&OBpu(SS^ zi36+v;2?a!0jdsZlE~auHP4G`JVQbZ}80{MrZ^ z^BA*DW(jD!j0!i^woke92~LRHs8*9I9OlqAxyk1aV+AW93eh;oDPkj^lf-@KDhG~( zoD+cs#r%2aa+yokGQk2T0YxGcqN@ZQ!N`eB)Z%nx?49ozqegIXMJsLui@DBHATM%s z7oHnqDI5esH1-i?_zI*pkT=K=L8&EGI@lrw3XkbQQj(LbBtdGVz3pkzdp-(Z3qa|S z@`1!&N>U#xefrZ9z3+Yaph*rqij$o1;txBqXkWqXbp$N%o&P-XBGMT~b+S>NQ7s6AX zI1DXp?5P`6@r{Rm^G!d0NVp-=DtZH@-@|xCTl-1wiIk(96fLJlp!LUf%nHy-ApyH; z*70^8{X@1+2QM?$l%$$FU{_M=EJ#?l0~tN;7n5r`ZIw}Vg&}E@N(sn7_KT-JHKd3T zsScsG1A4J_Si>Nu51vTOk~YF*j-Coti+qx*q8ufKOsUnBtdAw^pwg6-6Eo-V0&-{N zj#`D%);}BtuD&!AU4>b+yoSq76aA|*$I`&TMy);8M659AvQ2J!vuoh|+F-~@V-r@2 z3Ft(p{yNj<1Sa(O$1D`hr{MY77|tyP@bI6j6;2QdN1R$kZ(*}tBCjF` zx!dMeSi8+xZ`p_lEY2<$#TDHzZs!TuDOWGBvyZ%4d!sUq2K*+tj6?@}+BNgeH|zYuW&3q(z7P&(se zSj}qs46NQLRq1dHW>JK;*zL7V|6!)=7U(o- zMvzZ-Oin6(yf?Zw{&r=b~>m>T2QY?sQE3VqDucDge(@N~ixKubeXohr1q(cx+S z_vynZPkD&{eC@&(h9!N}wtlviTtmSe<|!tVb7pSDSe`YB;`-ut5O4FF;rs`9&H0Su zRHK{lj8ZLn{14b|iye&+Xo|y2QD+?6P06ch4sqys$@^(b3f5jppGaYjlyA*2jU7$X zsHr#NFDHHEf~k(0sw68}GX|Wpt+H&DE;$@nl_P6R{GnI1_KD|&;<+!uE)yHzfLww7 z1G++`XvKV;Ua!?x4&>SGD7_XD#FA$sU=(zOEkY(xoMLIOco^2!8V8kd1bG=goHOP& zWt;Hr8&@V%nPnSh+~#8!zEj=m4%Ly7Ov4-Qt+cCha^G5I?|i$q%8bPFBU}CyorLyk zp}38r6mvF3WpP}kjM#H8Ku&};%LjIaN zR(+E2Lz+aewj8_ibsV4*1!#3z=VtIB6jpZ$#3Xj6V zUf;(Otwu03S0Y1|BC5xF{#IYW!hS&KRPi@-oirpOGd@*iKI2sl(V#L;0(CZbEA&Hv zXtf=%qXVnRikCoPyT${%<^!_mfJ^~9zZNvEV0ImrSK{Jk=8*|rA&hf41a8&{%V&Z_ z@CPQyjC$v0)bbW8m`(FBeOeQPFNktz1c=60PUj>UD1=#RGkHJeV?g#cLxy=zu#TE{ z8l5+UpZ8>=2RN)HW&f0Kgkw1SrhZCfPzIGyUS=}`S8zn}{v99og~COL*VSjz_-AH# zhJBG-4}t_X6*iIahD)P-#rQN*14f&Wha{&LNRWoamv~}xks~oYg}76VW?(YMJT<3C zlSWjlM?FY2i8PWB+5>-|hKUhjbfw0L9brED*L17qf9C*`&SQ!+13P1dRy(nZt;hp^ zkZZfv1GvZo!S+jkpo{xKSG}lqYNuEJky6J|GFDMEH`>Zoq(7=)ZhDodtMqKAa^_BW;1TCy@L zPZ)*tQ-w8CR$2mkS-4yJLwjAgEX;Ifc|r+yxCx&A5O!gwdmP|9HbqX4;uvojhhnjO z1G13m0(}k%3Lq7cZZ?q>DMFF4a`{qTi{^4L$5mZ5eldwK@a0H~b5uFOb6c_<0MLH< zwLPBZ5KuLLLPAxiRxf`PicSZeF2g)9!IaSfJ3By2tSFU#5EQz0Emc{ITDg@?fr~&R z6~WevhG1;Q#yMs=hYMtk`pK4Rp$X3zmvVVcRs(o077BS;c*Mt-VY3*>$rzOKZIlri zgsC==cNsqh8s-QZn5T}78H6(gZ}CW(^Y&!?#DtnjWtn*#QV5Ai6iEOXkg=y*vsaM# z*@bcF2(o!CeS=b&lfQOWg@6hxPxfEO(&3NVPF zees7i#h2X(qJW8GXk%HC*BO|hqKb)bF8ZQz6Ql5`PfezT^f);7h?)2{W%@=x^kp3f z)kFa|IkH!zL_uL)_$G;fdyVi>3b;ke<(h(`7tQ5d9SWk!>4plVmduzZeD<4c29i%& z3lnLZZ0H!cS*9vkJZh>utrjJV$o_~k>4-TuU)V{f*`XcXd8a|Ar&0BjeaeX;;YZ}9 zo-4zq2qvA11fPwA6Y|NZuBdfY$z3B`mBF?YxcHyKCO}YusYP=Y9>%Gi6FXNLAS7#d z?RtWHf{Ih4Vijta7s{&Hs5%_#q2q+FCd34cmrj#+qMKokE9y?4L1c{iqEG+@?O23M zMx#kMdX`y_nt6Jsmzl`XnGX|*ys{laO08OmOQm_FmqSt9x^U1^s%)VNf$|9uDVq<{ zZ6k!QxG6g$wwCKrTrLHi!Vr8Sm2%^Bo5{%pWSUcGYCP!muRuk9rC6QPV`$GB3q05$#q>>i#!B=>#%9l}^a)V*Cl;yaN zfi~f`Lgg45E9y2>`=X6`wWRTmTFV<RBkG1u@+zRwR5)xW(vCk8`H2tx2OJD+^Bm{0tYrciKDV3L)=hnXN`vg~uwWSfG@mPe!N^i%? zg!f2gV@tNXGN+%3P*=DmUsiAh>?LrEzyZ=MWPzpEm1c(}eeyvH+R|K))wt>U$D*8& z8;rA(Pzi>sT@j1~MliugP{FebZYs>2{OX(lvl6P*J~1qlG;t!8MlBNg1$<#KbmP9rBrg_o-|98B>|y16Rxe!uu4wm@LMm zXNO>*2a^6=48)sb0nZ%ZmVdAowF8&eTcN5N3V30SLW_;u3qpOHaz-nN3i+M%A?@QUZZl6QcjgYrYqUPAo9XW z>0Sv#bp`9Aom;22wpIY3!)&cd*!(d+S#+wqx@)o=WV@wp%|4#U1zg z6R(J$y=x0Ta0$Un3rw-HPf>wiTooTT3$ri;x3EBI*{!u;AZWpR8np|TKsCY134}t& zF85U>haAQGo^u#c%|%xuo1SDUWL@2)w~`hh`wx9u8-!iCY)E zJX74#E!;Mx<(tA=-POiy4wg$Wn9Iyd{LHc>iJY82m%|VnvoQ|)J*Ycs-R#X+b=S}! z&KJTyUo9fE>(?{WdcU&V*NUG#Kw-4l;s2A1Qo$c#={jDxtqJ5z3hW3^^K7-V79Qm% zRYQ%0vZ~!=7%v|X}@1{yOT? zP?#k<;lH6N&B~481q>$6%>zAvz^a*1(;`O7H4H-i%kz2(Cn?NZE#9@vmLUh)2?CON z;iZ{y!QTzuXL=$1@^a`Ueqk-cV?8tJXTvqkB>^6u1s+xZ<)_PF*8>(v-tctlH6ne@ zv7U*A)BI2rRuo=t#bff}WEbKD%2y?>2wnkL3{)13a4vbbCmGcX)(a?kOWF+`w04~9 zhgY=W`?q9MS+1Q~>1&R&&7y{E+eei+lWU02 z`NBzAB}=)nSCVCCE6rLM-~_(te7cDWE)5Ls;IIqfq$u#1KGRI3$2rc1zs}>qK90hEj){5f z$ezei5WmBkgw5VVOE@^o`t&Rv<;3le*D)Q^s>x{G$v2IkaEq;9u5gcVF67>`=}kse zO;dEH<4Aipl+j}VpyC8lE%)vT>m5=j=QWDw^ZTyCd``LGX9MIA;Taogf=N z@+#iyEFVDz{qk}T!A%;$+I!k}%%QZo^M(-_g2?7ft0`=gqC@_xMSrzXpvd#fH%s3t zsujslAMMjF0;cw=(|87X;#gF|_fQ>nRA z$+?sB8M-q{I;vx;le&|d$^)V(+!%V16s;T-m1gH)1#x#-qXY56aFtB|Kn5tgP#wy&kq#j|09UN zfkB283?f9x5QPkh3~@MQND(3wi4?hru}FuF8aH}0vJs?_kt9nVIf*jmNhL>EwrrUs zW=thClh9PsM9C7JI-4x{33LgQp+tw0U~-g%(xpyFIBELS=~E|9o<6yX^$C=%T%knS z3IG6u1`WoJElc(+*|lufIw0!+LtF=Q={9&v*RI~Yck}wq-~hm2_w3k5Fmsa1?m zIWAX@$2nH&&{@8m4nRbS7BP0vcu^z=4u4Aj8LjdNlGR8~kCvG;_Gk`EN;g5eBq>rR z0324N`1x~3ksV5oL}>(xY9ynP%(R)LNo<@;{zeBqI<%=$0L}<`A4JH8jA_*xJ;F9= zo2E>haCmYL-&0{zs~}HC_e$2RTDJQC;^m7l0uoaUG0YqY!!rsVLJbTyI9QD%=w+iG zH{Kw|7%BFlGg&(xx-*YF_t=vUKK=0Xk3jwqbdW&_F|^QTn_0wJXBl-wghx6OCsIkp z9oIo>D7nNEkuuGsgiT3K$I}u%1@%)=Md`K_Q%*54RhCq3nblQYarM<#VWG8_T5X-_ z7F=?zIhS00-38}fe$DCE0|0a*N_?aow&!B>IaZ&2_nA`}W|qCvgJv~S1X^%L6k)^$ zMwC|4X(_R`T9U5K#wlsG3B^QixjBLUB?+4SmSb?kh4dpyml}}-Yn#qAT@$m__Q!1` zfJ*980C-o3AcBY|O?it*I3b0WthWh#?71i3d>N8cpJdkN7Yl#>>2gajy$I-nfyW>- zE`ke2^PsVbNO)d)6?*ecIE4w?;X3Pl2x5r#>|3IVC;9_0ivk(sB8&|^gz#??-PmYH z#j*OZamF2Cgper_*;0~8D#U|dc}!X&_dG*7+rUY!>3`=)&~xtkI_5XebyR^&O4c*YEf{G7Dw8|N04?B zrq9J>TG^%nWmIlTVTomLzp4JJ5l9bnJ)26ft`@7Nopx%PPebKqvai5`2VSx2TGQ@? z+ho%0h0uZmt+Y=^CN;ME@t4aj|NR0CxCACsAc6@h=nR9!LKtDP63ayMw#F^>EOyzx!~oPY@iWC@{eYB^09&zR5UIMGWKE0S7up9DS=JwMwzYD{cSM z#?RG6({v(-3}wki1zsgoENfX6Rb6TYbC@%SrIwjGpZONgb+P&8UVYICKnG+1Fn5wy zw3arn#xw?M){+|4s#di`HE$vf3kjr(&^1?`1ZVw*f~u zpE1I0el!}>aNts6^ZuUM%!W4HFa;@2`Bis-MXW?n!&t~tohC3*3C2N=6HAPo z{_qdd2<%0COdb&wGNXt5=6TXf6=^=gDi=!ZI2E&461G<)=*Z+IO7d7v#y2vONr_4* zbBZTdHkGP~@@4UhSrkq=rkkZ@l{(8`n_l@d|IO)tL=&Jb?-U9r5(a?^oZN=YagGN< z&}tHNp4NyUw@0~<0~-7qX NmlYEJqgMtcleavOhi>Jj3K35SQ?bfa5>IF!p1a) zlMp_Mgqq|b{@bL&9l{k38iy;Q5m)Cd$Bn{?2^3TVFY^j3;-WtR;vBe!5eyg@NErtr zT^PlfuGHC6S&O?6VqT|49{eF4YrGd6->5Hs(eV%c`d5nd$Ra+zD0#|Dm>`|Uu;~54 zBZs7(X#OCv>}juikc0_z&}qq#k*|E_<7E0isil^=kCb1M-ziZE09D=(O|I95P zywEa$faxkOmB!0{I*ox*6Xu~T6*V>5e3ZDS0MqGzOd4d^fMR$uO3pl0tcohn{0x*Jbh93Dyxt zPxIjcfu$HsfRYw-{@Dc<4;rq7u2yuTBc16WD$&GIR2%RTg@Ek?$K8IEqwe@Er$qh= zggPFVQz!zSK#UTIaI#VMl?Z=c0?SUbf4z*SgkvY8~YhprIyQ=s} zc_qrpPN*dSaPxvA#wkfiT-XyM*3XO0D~4T-&B%U-vXxzzl*@QT&2l3?`sAnNs0HN9 z1aq{P(;O{)@vYP%l%Y#D*K5O=2-HRB8j`^0ZLOSJ$gr_Ap^oE6v&;b>lx8&h3UeL3 zc^W+W1Eu`-)M#Kdnjvh;-yC2RzDJ{xe3vGA%$&D%Z*A-2VAmxv$rxg(8U9r84mF1* zGwM+b%|5Fj8cgk7bSmdN)%vn2mb7en0Qn1Z0v;yQ&t4!|%W75xCm2xxU~t^#=Cw=3 zO2X1qXF7eo*Ob9Ho5Bgr1!el+aGoRyCO#*HR~?iR4*Dor>LKBzA=`0Z77{t2#JiYy z#{XXV$DTebwfi&Bg8t{ApIa!C9SRMIin|ezNZhjCmG);tMjblXEpOlWQ962x9;3;J zr;b}1ehhElcoZHUy_t}JE5uU~@zftELYj+s3N$sXsZ6H}^#@ZdIXf-V5gthspMtNF zy~ZR_JHGW#t}o>8gI`nGyXaF+A(drvw94tiKRNlV(l5U>f4}Nk{tfk#tda@xr$haY zwE7@X9&y-5B&HmcKof6PmktQ=%5kHVS1L|qgROCn_dv+&b^coYOaUcT zd>BN<;|VkeMNu>;50oe@umYLGEvSWL;=)=?)?|4HQDJ9U?P3XL zXIprJA!(#;_R>Zig?L_88uVZfVg`f26FfkGN04`Bmsc7qRT>LH8VExgzY%&D@du4k zdNai}sCQ>kw^Oh;brvT{;BylyW_!1{Nx7$c=d~s2$?yVS!oOmHU&{IeDD>9tu%&Kg;mH$C;IglF(*JW7kz(HA3IQrztnbALrmzPeeke-?}td% z!#6i%8s`)~lQ@XjL0(E%XrlCfJmOX)Q8rWOc|ZPTPL?D>tad&f>5(jhh{Ps<$2JKC zm{|uHiWV{$2h@v>v5=QxHPmKp*yb&;$ZZOBci%>1dv`44b_wQ2g1a;hztj%B^=>1D zl_L^nB;_gn&?zTXd8FZt$g^BM=n&Ot5kZ)Z`6g#Lb%fRBjo=hEa7A>lXO}4UK{df^ zO|o(OHzihRUWO)e@yLb2cS>JakHlwu`{<8l_&-|(kZLH9T?H6+VnFC7U^a)41V)Fg zkaMAyU^@p7-1l=4^I(nmdgXK^k*H4k2P%NmNh;HRTOw;9rc6PX5|3n9e3nk=cpFc$ zEByD8@A!W+W;kLucAkhtR2CoZK^P3^fc~I`if0vSqh)QIGk055Aji;J%}|S_6H!dr zE>Z@Sym)1UmkRCxj2q=!e-IBWsFjchdBr6|VQHUZnLNxTjS&%Ij1poPB2H#7=_fYHE`{ONSNzmq>P& z8WIMH<)~uh^CU?}Dzd4Czfx>YIUzQ=0|>~aO@t@S$xHq;otW_sqs59@bb;N*P~P@X z9k_|evMeH4QD_ukV#*FE=$;Bj{)}E0Z}k8KW9AxvAbG^Il{Z)rVySsN$N>>S1U)zr zKZp^bCs@+emN%t@B*7eifD+-?gbjLe9J7}o1741`jxJfD?x<84T9}53nD%&&js_Qu zSr?QxG$y)+{6(2|5@2<@K%3d32nkGeIHPxHqoe5#06-je7LHTraIe9dzA1<;25dzN zlP-g---l=6C}FS1XHOcW(z+|L31e4bt;V^DG${$nX$hX#2?z+LJXs0}8J$0geO2QF zW~vKCnWn4Noy&lCwir=SmJN|$MuB&pzDOCkvt>8Br|vl$KJcgB)Ro8>1OX94hB}sP zwx}ArgVJb?Ll~(7Dm@zh(THyuSl(Em%y9&oN=_cct*>Ww9kV2VHa?+3s#VC2r;3Fx zGjcJbq4a2vuKKDU3QHpzOS5XClR1zBNkEtRM1bYY+(90 z@M?mcCZmReJF3Vz-IAt9*{>VOAWKa_iIkWuTaF={V%=#b|N zB0HBTa-*aw(Yr$z6OH(!dLDouNM++(t!ojln{dHlHXT4I zO#Dr8iBn-iSmacf69&8xI;zC$YPlDfg4uf+8YUYWw9gB@(mTES(-&xXz04PxCmM5< zIY16zC#JxwP^Vw!R?`Apn!n#alz^KH1rCT3X8aCYLrO1 zrmpov-Elf^n!=O29+g|CRB12nptQ&r4gwzJ$txF zlRQJ3I(~)hpjV8@fOfORYpPd>ysG+pUASn@TgK6=m~7!njML8058z*l z(My|o$EF~@Et<#Xi(r3jqqtL>xJk*(v6i;+F_gH;ux7XWtGsE8(0G$6cxiO&q{y4h z$o{v#kNynFpsBKEduNsJVgFsK>$%(rx zr*q1}Q;DAGDaX;pz3`!sU1X197$hvwX!KtbdE16;wbVW^BtaTmP z$kj@&FeB2)sW_EDc1g5s7K|Zq2yIlGb4GoyM7g-i@B*_)i?=KT4nk}mcnv;Xo=Wq} z{wJ8ZF>TbuC?X`X)csJgDx%C#y<7@0)kRPv(yWJA%_G;`wvCj{${{w8=%DBnyb;=$ z6AG9}b=HHK*5_=PQJ~ImO~&m^y~j6cX6SPCjMw(uy>jed8UhZznvlNgtF}F?=c~Sd z+yj7&tX#XP3;hQamT{8ZEB!a6T;e`Z;CnP<5}hqJh=l}3x851%kxem59iC{bZCPWt zuCSfbVEPR#oxyr6tY<~6xiiz9qgoi)+rDkf3gR8&5!?ZLEV+0IKTWyj*}{}T)c2xb zxLw0aT_PqG5CQYl%zWL=@#i;zb-O%NI)B|+j?Y;?mSgLv6p!&^OJl5x9yyX1e$(x~i{#5l{#$+tL@4Vk7 zO6aoGeD$2@`1}9{&**XJOOOHSIc~W1inR`|*v9$;5x%TcY>^guVL$$X9gsz6#2Mf1 z72&Bd;=5L1ovv38-HvzbK9~(AsAL|Ts5oZFrKT*~&$%=$t-*zThs>?8xowo(SOeqP*?d(C#$}XI+)L!k@9-miUTmZ8V-7XN_u3Y)qQd3PM&ogS%^WEr9@*Sj_ z=KVoUplUP=?{hBib#9>`Z_dlR*6zjUWbEft@aKx@@2^B@g>I{p3E+Iq*L^);3lF1$ z4XkDbYF2~T+IORg4dIiV&}a{cBIIk~3OE_gexby_v5rdN*tT=^J?SmCK*5omZ|6(p z1d#mlFi+Bs5Q4ORL=`N8xvn&;%*wsa_z^VaKR?s3xMU(s|>!%Q_?bGcKSf5;5AC1op<_iN|)a>03hUP-T=53Dl4;tA%A=d0Y?`BP$ z_P(lKIL7PD@An;5TD9K+AMgTy=zGJ)oyPsi;0Z07gf!u}HH?NJ>e!w@pgCyh}?>z)MUdOT|tk$;nR0%*;?u zPfk$O)lt__Q2?>9vq(utN#f$VP3B7Gzrx1DOiskg&CO5J($&`3+BP;f`#AhJ0tyU> z<3>Ro2ovJiv9RHe91I^anmEzYq(_x>@X+XKQx6^={!57*S;_|h7bsD_Z~=oQjFvBB z%8Ws?W(*lOW$cTwuV>GI00kB_s4!uUqYxodoJdJhk4U9-lmbao2q(k2hfB_rnFt{*bBZw0x=Ee=l z5y#(XeH%xPSCS@|(V+{bWSzQpOhSt$K@6TU63tLMTOBPLz1L6fS<9B~n(Zi4aO0jb zMN01}8-VlP002OP;|&}jSDqY$^5@B)OLsuMy7lTA1ZmGcND!gyh{8Wu^r$?frjs^h z>d0QysQ2$rjrzDMRV&AgYt6bvd6&6#o{1Lz+G)$EMuI)e#3tKq*K8Au5#CHjPG!9O z_t`JSWJsVq2PWv+f(!!C4?jT-L{L#hF@)4n5-p_EQcOvL(MB|~=gCwdk(A0wDY>u` zODnzPl1wkzBm+)3*^rZxKK(?Zi6|PyqC_vo*wjW(Wr;~uRe7ZqS3qzD=2&E%6_yZc zwWTIpY!2b(n?n?VS6+PSGv7*Ydsr>!`01~gn0!}Tt;F8%czO2&(q?0;>T0I|XY8w<% zNa0{Nkx9tkfBpp%j5--Efy`+fB1n(8`QQe?lmD0~ltDx>)R03iMpWfe7Rd;#MjUk% z5>;H5wBwI0z3{?I7Y|9KO*J8TB$GTf2^5q>MY*CxFk;lyQ&5$1NyJ$7kk!myb@dgQ zWulelT5GlmS6y_)IcJ@A{-vj2eHNyepNIweSUBNCR;ZztVRo5+ou$*+g^-RG>4vDO zW@&4%y{0K`oO&ASZol~!TyVk>XB=~_vifRtvCgVDceUQyT_U>bY6!2s{+f{`Tdvoh zN5;l?tmCSba_*qt9FdDHxc+pu*=NC&W*WVff;)|-pxRdMxe-prU*;8Vy=~`Au%nDS zVKZ|exC-9mX>KAuNivE%l#EbB1f!g?BPyrI@UWcV2(eW%o8+TPELBhB#vLQc(~&xb zEVA!HMTrAaj3fo)uUJa8WsY59brsE7g^9D7Wu3KFT0OHBmk@KoDJNb;>x%%7W*DXY zNik0A1}vrpHA5vz9RJY_qn5C>&vb1-UjtjESR)NgnN3`s@)W3YBdXt+YB+C8)vD^& zDpxj;h1uZN$q1N?69q;1S zhBio#(UGn;Q7D(W{*iO7HsdAK}{T;hjM z>4+%k<42JcaVqs$)_sgns9Rdg78SD4FQO=*DGrltR=h{)KBYwm=?8P;=*1JE_zP~$ zix_A0P#Q`8cN;eLt{(@9V~TDdFya-@A;-f=^2*6Pk36h>s&G~z2`MB*7Abo-*&fK6 zw2yw+6kx(D3i+sXKJ=tdOD~Jq`@AAEPkL#7I(@#M8Kpm4N%bv z6n<>!KtxqbQJbrvI(`YvN!9M3&gh^q)fhqsjc_-kI^l5Q7R}?Z5N|J(RW|v?SMPAM z5Z@G>B6i5bV1XnPSt1tW+8Liw#Pf(L-A06{mQM+CPKuzb6g2L2MblZda@0yFE-Vzr zh6?B%qd4z)u}ppI6RP`)YSfzH3@u76r779eKcGRCXsxU&ESYxItTv{B z45ZAu9vH!N0ElZBlvFU!IyQ-}6@+P1CJCAOOyInY3RIAr-R^eHyf!$S+Vtypz>_N+ ziicO^G%QE9B$b9SmYwt|iDTjESjgU|P+c6YX5J-?CXgnB@lb7ATLZ$<#nv~^n%e4i zxzKe$O117VqdbZk&}zKavs#?OMG-<<+9D)iDJmZEcw3%?DX&J%a~?`lYLeq3*QG|% zo(;OkB%0bZD7Hn>PR+Lz^mW)}nuOUjS zxP}1{BvN5qu|V9|V?h>)&+>+7Rm`qO4`_-Uw1;bHb7Lu>O4rtc;G)FJPtgEb#+q#n zr(|>FEXEd^A_||ArJIl`OS!t1q=aFE*v?H7_e;jT*u}uS+?+I$rT{4sPA5seO8yoq zEmPkgNix)ach}BA7$qt7EEl#o)h<{e-bF`-?_P z0~ph`AtBr1+UaM$Z37CPW(%ze;TV>hhTc@QU{_t(a&D1?JANP!=0K8SwCyho(_vYE=8i&{Q&%6vAz9N963_ zwsJ;1JS;8q+lVQZ8315#T#d~Hrb!|*yq|>T6RCMhY^I2tv!uSDwy&sk?k*^Ern9Av z*Whj{uPV{o7pe-n;e=j{p(EZ^%zPDVr1fQfHNNq&RXS531i9%nZNd|x+|wvec{Qs! zol(17n>4IpU@gph0A#p_=#2HvXT9@Ur^4sAjw~%iyW-7V=*5yAChpY8bf-T($A@Cq zeb)i~Zc(v=Yz39md6VsV%TcFO<|rdT3L}eXB6-0|=Z(q@vvbe>%p@2~t|DW~z2=%3 zx^cv9<5O?dbxBSEXPd-H{#Iw96mX=(Gvg%}k@r-Sr*N)>G)d!d2;?-hglM%iak^Ar z7H4&)1!<%=X_V$cAG9FJ#2_M9DkSGjowfl97JHw@VAo-Ldxd*{^*0s9d%ag2LO6s( zScFD+gh-f#O1Okf*o02_gisiTQaFWFScO)2g;0+)D+l!%F#*aDvTiJ<=20xuwnJ|c=N z7C&I}6^l1N^kXJM00h_gfDou>J_9G-=sy!!fdMp*f3a{?b$RWTd02G>?qz6@@fea3 zbn- z*@>MPilFEMqS%w9IEpE;5<=-C$3=HWxo*i-B>pd@TrePuvN&csp%eQc12;gGR#}yh zq>E&i12>QZ2;r4rIe_&hjK3I+_J%yj(_7^cBR3*^BJn)*2R&QSELzb?Gb2A@0v6I3 zO4ZnS4~Qm!xs6QKjo|1eMGz;5d6@qLK$PbfMo=^t$Z!ROdFluYuW*^{n3;m|j*xLs z%hy$)X^-^?dYXeZ`nZq9zz$>;X#+_w{Ix*`nRF@`8??!gXj2@a_FyenYBNNU;ZZ{u z350IQk#l&5b?A{K$%o3BoF*xVEcu)**^)1Lh%V`flX#srX^EDIlR6oSKpB*#NR;Av zibqLzF@Ti&Cj(8{lriOQi{x$}6P06z{*_lrl~|dTCc>5B^JHNOmJg8>06LauX&#y| z3G4G_9+p@Nx^Ft7jL+CC@UxdU!+>G|UVe#Zd3HbC_!e*x7alr+h8d!YDKrU3j(%Z| zmp5pFff(ty7?_Ef2_z`-6*W@>T8YMdnZr7xxf%D^VvMqV76dPk;yGBynqX6qS{IwH zk&u}Z8(pUVG#FL0hQz;21Op6cl_IRT&XNsI6n5cYYW zxi}PD`FGRQi3Mfn%z=*uxWZsdM~xfkZF?*4%tGY24PkzVH5V751@wPfkRxH z2pQ?6aVU~uI;Q^Ghh=(_D#?;4X^7P6rf<3eaXP1TYLlMGiQO5BJu*FfI+T7|p6Vv3 z7qfrMWvH$gi)AL2W=56I<*2&Ym40UwmFkrSLtU5}jNsO(3*$qCM=biLpyt*rSdj{0 z(n)p6s?z9P6*@}vlNSCM8kmB~RBqBHeTJ)w2~~`#a8gyQhS6{t*rLk{ql|$cPZM9d zCN-c1n)IlnSkru=H-e|xt+Hbb8HZZ?RUk-uMrh>>&``Hrw^>aJ1q;bmQEDCS+Hz-@ zds!-+gquV9+OJ{?rix3F0$Z>JyQYNbrq%hT3(K$#yPcUBv3c5)J@O+fRg^3Rs2W?S zch`y@`-*x;iz53y070^mDiB;bsbATjNHKu_dAk!)NyGSCh=W+?6sp2Usygx|tZ=Fj z`m>7nZ=poANd>Eci6*kTp-hXb2S=h%+pFX#tlAryl8Jd(>!O*NRhP-NPm>=FbW0Kv znv0gBqlv9Q>i(nKI##B|kHrug?+|2f8?JGCkaXL>dTXwFYn$n68-0s|?i#qhsVg-E zoLY*n4xF!t8;6QJrhiDmC7F_Hs-|ozod=t+ajLME>#z?Su{+t5o=ZK1G(CTMl%qSS z9NUVCdL)WEQ>*((HHC}O6}vgrpJLgvw`*^lS~xS?yIFEh#+W16HC)6MJ@-dc$t$4_ zI7$L1#cFZ18X5$$8oj2pv<3H6sf3tN8?{qQtb8%7-P8_<^CR zP?wwz$yjXnATI?2k zMg;uBKVF=eVf?F8YmUW=#s!3|m8q=l7%k4q4b!rGQX{t2GS54@Y{H;9zaUonn3{W> zA7)oJ_TWo7UvW?|P-*A+HQ9$q)Ph5FEjm+?;?ouq$b> z9Q=|V45uMXiFQiDJed+Eyr+Filoo@rMmZCO`obOKp0VhEWkyr~@LV_yFq4Y1Ub(XV zD@#5uLVz(#pey6MMH~`uCR{noWm*wEJ^Rd`6mXzqq0H;NSDeMz%qF+G&E9NY;Vi~` z0cd8uy(ucJX^hTTwX6@KKnk=(^+YK4bfc6dns)39_{?m2thVt|zn(*S10Bd5!oP)l z&~_WZ=bFe2tqsxyk%0TiSPD)J%zF@!0hir-`ijYZ_^*u%ot*5+2ur!zIm+C5r#hL^ zn`^NsjEaC7(=zSCFYJo^SIa$N%Qx%~;6pNT6x6dj)Vv7H!Hm@R770pi#6aYBn>3eD z-NerPZ$itLN`;|U447V0gS;Acd$)$HkafGz`OwhPBr8-J z(YZ&_!D+9+iP4yi+2di!i2JXZEU;+`orWm639GP+Sc!A0iJ6Gn-H8&M%cm-_QZD_{ zuN~VnP1Cdul}WM_w>%;~-qQu4!@SJH!A*d}y}L=BI7=;SPW{x(xXjE*)zg?WWMQFy zS>0-q-C6u5dq#m_4c_4`K;@WTtyDm2ZMAB=#+u22<$Gvz4aZ`eP@-wy&3CO9@-FeK zwxYqdUK45iHQ=u)HU-{6g^b_}zPBvc*bOo_x_Q783CWag(H4H$l>V;al}wxytO6&X z=^m-+p6-Vj9NKOA$tC{5l~~%?39+So%04NSq`1oDS>ra2<1w6fAA{T9Ga~=cFDJXp zUHRL-T;x=887;vc4yK;I>6;$nD7oo|NU$Ld%8MAMr+(^_sNyTW>a4!n zD%{en4BIi`!m&*2GE8PX;eWO~B76sc|MJs1+{>5hvbalS{y}W)N^Z* z&`8zLF5Qi1#m_sKw)#}voJ!Yz7u+t6WBl!brWfKK?&!_dZ5_Tb8rQP$&XO@1@-63c zZnpQ>YZkZPL+Z}}d4jY9=&QxQ;DXqOzS!tm8-73VIq2wpLy?gz$(fDel}_m!j_Lk7 z@qJkFkN@e9o57<#+KzbQ3VV|w&z%vQ(k`B-d}@lH3%cdGG0Nrg9~<*I-Q&C6WN;LK zL9P%-0o=aGQ$CO6#;()|DiUt#Z1}yuR?>3-X@+k8gjPsYzD9_TQ2gWO7^B{Hyng zJvxZY*aPe-eG6fRfO`|3@PLr<@Zd0LcsK|lsK}TB@c;pEGI^4Ml2VzeqFITlf}#?t zlCmi}YHGToqPo)R>e|v8yD}Tga@*3vqMO_6o9hzn@{&tzJp3|@{KEVK;|vWWJskrR z^AeM-y`3!+BjYV&6Js-8Zcct)eq+P#-rjzLV}o-ef1h)ckHepngY(ayKz}=O6ePGK zp~8g;b?k7cBcjBJJs$SZaWNytjXgSg{0Oq6j~_ltjvU#8xz)*>CUcIf&wtk|zc zij*~Cglt;09niXci}r{SxpR#mnR_I!UcE{3BKZp#N#7)d1rt7un6Q$?j2kOy@;Gvn z$&;5fv5a|%=FOZnGx_|P#1ayqNtMnzJoMC4&p!P06A(ZH5rktw4DI+(j}u8$5k@;y zMC6bhb#!D%ADL7VNhiUS5=<-6Boj?GU5QhcKk@XFP+lGd=2A*A#ne<$MRgULSZ$>h zSX_ZM)>vnq)mEKw-5FP&d+n(g5`G2tR}z5=c7&jb9i~JQi7u+BV~{im^N!6KGRn-9zY`TeaoMeTy z)>>`#4D?%c$tBlack%frpnx7`*rA9y1~sIRNm^N@msz@*XiH>@+GwMp1~#Xk#ztDH zw%K-SZoBaYTX3%m2WxT8IhP!*(AjDou7qf}Yk0kex7{GQo_F4{>#-LJ3h^mU-+ay1 zSKqXwKnsc~)uO`6D%q~EE$6Y=@_B+TC@3y44hAEkgyyP#u7%8Gh~b9T%r0*?A%X}_ ziT9$Y4!1aPkT-?4!d%Zp6`$8gbweMjmaTWJw!n@8k~~tQ4h8 zGqq%8$S!f#Q@M%}IcGatqPiVl=z( zNoh+HOrQ+qG)76#QIT1~VczVItk-D@7`bNAT`3ycy|3A2mWA!VaRNtP~<1;oR(XA+DnBIHUDipWh)Kh?UNC|IEi7Ccc~oZ}pVaB(19h;A3+YS4pLhc0F; zGa8;ijyDiI=0FDt(<8&2M-hkxa$-GrBo9LJ z$o`Hzl1Ul!!A_qv$v=E-N>#d2Ce^pTpMa7m@|)i&?I#sgvQmFksTnMBc2xk1MSx}@ zATIS}7X|jRPk=gt(hN1sLrG9kjXGupBNZviVCHHX)EWo7wkc|ca8%etTQ=9GP2Z%d zo5fk-H)Zug7)C(~wz}2c$fF(cs1sNZ5Y~8lSgd#+4gmFR+~e{?E&edkpP|THKnF_D zgR1tRxnQUj8Tt!hs4E#;WL@hj1V)R(i;QKgm+sP`#@?+X9x4(kz(`s=;}tBWcSMLw z`PfH`Py~=k(m_sf`UfA>G`kpk(oR3t5}!8mB{rGKl#B|5N0O{d?$hMS;^)*c{y`O$ zteh$lYR13&>KDIXiDdwHMoYK+?5laH3tAFbv|g4qFc5U0poB?GW4aYmaHZN@o5>lj zZOVhDktV3f#@B256;*)c&0q)Xs&C3ooQWmpV$FHZ>)a5BKFo#7-A(Z z(TO1EbIAMTr?pHQPyrQmwYxY_Yg_A324yjIw7qS*D4L;aylaf|(x^r|>d`h9*Nr2E zV@U~SBZJ|nrO$F)aMA!{ zRghHk9+5a8JMM9k!)GZjN7~X}OP~TxtwC4&IVY3uwXr2vF;oXpE5EK? z*VuB0c%2ut<2M>jhU&Vfu4lIr}Co&MpGf5@(QKOR&@ za(v_Hvl5<#n!cQP$-%TiYsOWbV3ZnW?L1pt<4H1pEHOqM{9{jGZ>No$$nl zJ#4d`-JEjD9mdqzTiyHiw;b{ivNwLGW_QfvAab^|p3RTBmuRhPwc`a{&xLNJBgcF4LUTOjM`gKBKzVXc5=G{c7Q!Er!f~cNQu>zu0})P6mE`;U=ldnK z&`S;A0S}nKx!k1!W9=8HL*0Q7bZ}yXxz=1S22vKJ8rSKH;k$-i*uy59u}7SCCYCB| zLmb`IcCdn2gx9gx*45hxyeR|wm7S;Vq!fBqME-xaV;pw^Jeadokf>>E&nYqjH*r6QOi`n#6HOfqXT`6wfDp z&sPMR)^RcONZI#DK9?1(Bx>IGU$t~S+(b7Z!b%MXxcue*!{=!%OFiyLS-JT`ci5P~46MEi6fN49Rjh#)5@j0n{WEhuG_$3<6mgE$B~ z&$xrp*n>ZaMnEWLLx_#pczWB&jXQw;11fbet+#{<1AA{Kdl?}y)>AQcrd_(Hdo1B+ zyqAT6=}33RabDP7Jy9};xm5k=hGP_iR7|2wAa>Y!LD2Zd2SC&X@Xaj(1;GlsQI}fVY91g_QA;l#!#9mgAJZh=T0qc*4jFu+>mjBwI9?mCLv; z`_`5IhEZTCBH$2uVODTLXnJX>aK+P>{J@sTa}cd3j&%8ia&{yZr&Au6F+D|vC-HmY zrG@c0UO%9ZCpR)cAOv41N3*phVIE0AuE}e$>2>-SY$&N$W=BG~X+pc%O}#0T38+}YX_Gfu zoOg$uJE?cWVq+J`ZQACX-xfqhc?p-0l<0HyThK3+okOT=8beLxyXQHI0nJL;c59yiZhcxM@ zex*4WQs;ggnJ7)rR{pH1qm$BWUbi)1$6?Y`iNi*0eRXUlMu0Dgq;V69a3`FkNQw<; zoDaAwf5UgHXb4t{r9-KuL^+E=lq~b{fuE&M{j?wcfn>j^g5CLe--$&I#iliAW#@^W z&ZwSrDvh~Ajl5%xX1S-@xQ%~$pZVEbcm#2CiKx?6aTJ4>I7LY&k$mvD67Z;?y*CqG zD17p`UJ|-;6BT=8{X&(BIIA?PoimKapeLZ)Xa58k8S#&F!bP|adNMjcjNu#;S zG=}(oit($u_9zwvo5R{nK3ba}By2)@8$@bCn+UDG>2@x(q)qCiQ}Cqdlq-JIlY{V+ zH};CKcsPKE{$sOflwW$CL{=?LX$tK&P$?LU-kGN1a+UXruMyRZvD2>r_jv+$4#8D$ zAa!v5Vz6onsBFo&YX)&X(j!6gF#j2`i%PMN$z47rXjVw6yq9M+(P-+WsbMIxl_qmS zafSk^hSNuVtBR1>$A&gzGctQK{#CR86*Me5s}fnOvPPPDF&L&vh_uG5y$Y<0_$XB~ zk|bHIr4dc4@io+hiOeds+eEdz=_&`fVptoTac8Y^*QC;MiZ#?7Ve75gb_lQNoa#ZY zL|Kc}8G?qlizNt9N*0V~`YlydI#;B(Rd!o9m|I>sryt^FBNDJELV9Oeg!PG^i@UhW z<9dbu3b}_GQ-E}rf+V2X)1e(|5+u=~8S8tLDoHfap*AsmNhP5Yy1^S<6w3E}D@-Q; zm=rMlh6Y)pli7wG$0lWQqPM$Mw{%NM2UdHsvt%WsgfhH_Q794ik*tZl6||#WhczWR zn_|a*ssXjQQN7NJz0s;-O1h+rrL|m3#yBZMI?0pl#6!%9SwdNqI|g`Ly0&cVAL$mi z@ERbEhrjvjT6h~E)D}4Hq{iR6cj2mm-=?QcJccT9(14UOjMU@CFzx39al0t zQL-qr%3#vUrgTcMY!$OihqSC|MWDl8LDOL2!{HaivWh3X+q+4_7li`UhG?U=#wflD z8I6Io6?Q=xw9K9HYt3xMSDeLY*Q^3~VlXL_Ga1HOD+OfS)!-b?%2|QkO8(Y`!<_58 zfwBm0a~!|yI?vmQ$Mrmwx}d-H3drPAgD^mz{;XR8?ICqKmUoK42d%)4tk95**bywj z5&bZMBs~(yzQqsS49t(LbwNyRy`f0;JO| zN~^g9%zq(k8M%>5T)a4%1V;^$NBx@1JH=n;yeH|jwyBcEolR=@tW~SMT1~Cp48GqC z*5Zp!VO!3J0Iq%~u5rxH+s)P@sFeL-$9LRrdOVf+>&N;$p6Qa;{ajIfJ-~ncuN+m- zgDszpoR$a6&cD+|k9Lqhe+w8sm&fTO%4$ijHtw@f(7>M0j zs?KT)Q>eg$` zM{2b#1e~LY>(IUOysn%;=}wJcwlm+p+giUhd`l z`V9T1^ku$L?+Ks#0`7>*=Hp)OZE5b03%M{wahd!P7Hu)_4pav2NLnZp9MG}#t`igb zJ|*+n?=y2LQ$H&m@Uy&WBFX_H`sf|b!)Ag04k_Zij3-QoG#B~s47S8d%*63$@kWjD z!kR(8hU$qAy;lqfBu;`Pf=-8nh>D9(PySAhjggH|Pn1xXn3nq@_|* zr>9e^tgHY44-T=jva=7gx4F6y8N9x|z`qc}!4MC_#>mJK04XZY(9hB;)G932*w@-D z+}qvX-z_XH;^gM%E-fzWE-x+a@b51#?Jh9$_xUgPF)uMN0RIV$L9n2~7%~thlwl)A z!-o$Y+L$=;MnxMIZ)DWS@dgf$AaRHsNfO5nlQ(vxJjv4Jj+ZcF?%?rK$BrI5bm-K9 zv*%5nJ$d#JDzt~uqezYVSju$ikEK9-JpDnH!=I{Gss8u_#43=lL4bq}GS(_tvOt6c zQLFZkkhfOf$`vxC?hv|m>k`q+{$WTFzeE1`En<}j;Ub6=D>jmtaS_HH9(R~L*+}IM zmW^cA%(*k?Bbq^rHgcr2=_5#xpia#iNs`pBW4lg5yLN3QxO3-jqNIuM-M)i2Su%Y1 zlH$=)3o*m=Qs6MhD5Kzl$N=z63eHdyVKo#|s7*H3fTLkI<&1OA zhw8ACPCM_^GmnY$q^J)+{_F#TKrbF-&_W9-2<)~vu74g`SMjr*~QAs8h*%C`f z%A{mWH06}jPC&gh)RaH|O_@|tNgdVHR8m1D6;)DkuoYHR0rA6EUV)`1T4s^O)>>=L zB}80v<%L&Xd+jxZRelj+SP^~}M%W*UJyt|yhZ^b_V~k?vsAZ2n>e-}7kVe{Rn4+d> z605QHnrpMoX4`E^C{gOEy5YuKaJ>mv9C69Tnw)dAMu%N>x8~ZNA>4iUop|JxSIK$k zWwM@n?TtcTDyZ1!EETWdV#|L3R{KCO*b->qw#jsxpfV8*)66p~Kqz5_7p9wGH|uW5 zp@$xVs7{FM#50dPD5i+diY*58;=eK;L?c2FNfeQe7$uC6k3WVK5|Jdal+sE@y0j!r zP0n=FlRRxqWl;W85@ltUNHw*kmt2xbrkP)L^+#A@iG@}W90c)lSZ}f=C!KHEnU`Kb z5Bis%L<@}=2ZbUwnW2e7)+l9?Vz$|&o`GiRXs4;Bsn)HvCflfBmzwHsy_LPHtH!}9 zYjVrcYMpd&UniY)xe~ISA>R3V2(aS?JFF$edLp=b?6oJ~;q*Cs-+j^cXN$A}W-GZb z2U5=9<;ye!O}XS&h%ScSxEszm@ybi@I`7C+B0VX#gU>!Ly2uZ}FZvTOLN?OK5RM4% zc+o};I~*jDM^^ljkryx7Bu*Sh*)hmGVM#K{Cv({)m|AgQRrXnRh33oJYacUNZHBMC z&K%6ev;O&c^<@`fdz$|j(nMR8nEi<|9T}sCQr4(umjNKvs8%V_WC~NNQ4OcO7Ao3^ z3T&o|AgWTeDzmwYIImh8+?L?B=fn*sI7QrjMjpq@4lZ1H!XRKo-3lz&@R(%vV z1^hq@0Q-3ywXC&^$r(r(-J)EAz6CC2I7mV%DAx)ov_y4O6jS%-tqd`v+@{7hj3HEdiia>&D55aU|f zvfK}Uh&cs?3jz+BP!gH=IVXw^933*9IYcxfEV}MQ`s!jA0kRK)v`CBt8`!~mhem~I zM2&3}9`THaJme)$CQYIVPCC}HDpd)PfutT&Qbx$AOoe+|VdR-yMzc?zMUpnPsan#f zNx8(ul7fj}UHCMFy%dHBM;+9kR(Tl2K*p)E zKRdJ*w~9fzV$gGl47z9L&XvS{s$hvLXyRqF@r`yx5nkz_;_0xsx_rHEMF2@{Kg1}b zh!%_@XQT*^7KYJ`x)F|XM9CbB7n3_GDPuHgl1@BET<94Er77*fAiLxPml`sr+cOi* zUUnw0*i>fI&2CNM^p;GnPcWa%3nWX)mp>TQyn!s)56#O)<%K%-&!SR=!atGnd1`TE&ez)S;UQtw~M0@=gAm+hpOf*yC6C zh!b(-9PBF4iOw4$ww(j=VPk=~AbQpl0{0A8KKZ#>%w9ILO-$E6xe-u-o-Q3%TwUw* zwMEpXHXsDC-R&Z(kljIqq8Cvk8yn`vA(e!;9YxYdne>w771v{aL~e4C@`D~c<$5i> zUQA^Q)9+0eyFZw&CEaAcoo$j&ME#j4i&|7c2@0v~HQIXP+nAGqZzl1L1WfEX@%rqOQJbL^gx9!o70%n}1ClvuL>$*jel z3>H$xiNrR_44X1Xs*Ky*&XHnu+<|XFn#YZO8Du9t?#Pns12Zf4%w3AgbJwiM>T*Ra z*1cJr$#+UP)iiuQy)$@&il;r-ZhNN+b7G`q6}kO4})8Bgl>Ab zZd}H9!o^4LCU{~NNcC1`_I74Z;aq02crw*8W)WxBRWsOSK9ol@K`;byf_ZK+RNxg# zLKS*}Vm~Y>Xr?zAF-RHxgBglKRRY9%ScOae`DGfsq(HtDgkMu>W2JJMhE~GSd$H1K z929di_h7eDd^dM|IoB(Cb79)#eBIPnoFH_g@L?Zjbk8zk*r#+j1R#l(482x4P^Sz( z6n<4FY?5VuT8CL&#{!zAY+(0ntUgFlK&s zn10FDb?Zku?dNQvg$}8cI`J2O@;8X~SBL|le{Sbwyz_00xJJQ4Zsk^hbaa4t#CPuY zF%1YvB13QXhIoWjf%~>*W+FZs$Q1-9XCR14+~rB(GhUoj7c(h~K$RyT=x5qPdWYg( zgVKw=2#ocGgSM1a9#rV)CHTec}bA879mK2fkB%+6ByzpUYArvVxVucN|-Z9bG9`re=i} zwrV~HIM2t0<_K7`Mr(vshDg_r+&7o<$SuD%kM^_-09ubngnoYcm;K0W0V$BF;|}#w zkYy)`ig|y9h;6O4f8N%AaQ8bsVwsnDTLh?E2FRHR*lrrLfE&XDqgh-aBX66SB@vjK zBiURf*_t!ONMaFZ{&9v~*d=*6GlD+aGb6a0cQK?5_jyK2G)0p%iUCW6(E-Z|l>f7O z!`K-{sb8a^l+>v;vqywP2th_Dl}JdH8YG^e=0R{ZH>E~ld2@w#g<)D~mhkC?X&Htg zHiq`;mS(7H0pd>jNtbqMIdHfj;bM=2I-oUHpa!akgE>VXVwekhP}D|OE*9IeoND!{|b{CqV5lLGUiJ2R9ZWk${8R?mR_dLZF zW`8tq)AOPt$*QbbCNuS_8#oqcv7@${Gjc)~LCULo1~k9A7k?qF!K$Q*!K57Eq(G^x zI4F!Aw@cD#rCE9!(ke^XN9duNR8Eam1R0}&~ctrsHPRRbLSe4;;620 z+J&$-baM(=M<=gty8-m7ebtf-e3~tl!=DQhsN+X<{o1$wdZ>shuwS>R0_CV!gaPOe z7w}LEyO^r}wU7mo5RF?SnJTfHDt7_ssRIbAcqgh`R*9hbnKzN5EQ+e07?LctnkjoG zE88+Qvq&=ovoZUUGfT5R^D}yqCprrlfZ`{^S}4V8tU}A20YqO!37tu4K(Ggdu~Bj+ z_drl9V9q$TE0?XD)_X8#l~}p8bmO&kgM8|FP3%b?Zwhqq`9khWee`*KZac43a6@yu zr*-+hZ5TxQ8lZg3w*YVr`iN{TkXc`cprUoKCW0cSMToL9scT26G5`Y&0kJh=15Spa z2t&D@N|7I`vAhKnBdU=lS`&YVqM#dZp*v%6z|rB$1)Nm!M$ zqP3ugD|EAsUJ16S#t3anmS$@#aZ0{xD~9$FuXj4HaLc~$*h2&&PnQ#ZdfBh_TfYvX zS%|s<`}9eTN$8HpR)nHuS3 zHW8Yq`hY2=s--KVr;EBN+`{8CK5pW|G8?;cVHY<1K0t${xSP8@T&z$vw2l(I&)IQS zW4uV28cVs1%ILJs=)7eWz1UhDyhp{scfHt)#p3#v$LEd8H@3}JmOxjIoz>t%uGF`!$T@n3J^WPg6~t0HyaR+am*R0;mBgm8rPnD|me#yY0KJ)3K~_7(;MuLt z>`d0d1Wu5>aYapd6SiV$&DR{p>G5iE`h`Si#;t(H=?k}B4Y%zmmjjYwcYBv+jUbU# zk98blgDPX7Be3cxxbM<_jA}ZD`>2Fm$oNO8w_~Y|>B!yII}%KHll(@Q{(HfbxVe32 ziJZ)UMo}ddZP5}K$|WqyCYicl@xp2{NiKXAJ<7_h+^at`GKIT38Nf?R z%W6wBjVU3Aj7z+X09MSV^3%^)HfOba%Usl1d(>APuG?!JI9IOU_{HtXO@RY_@i~2h zHHKWBba1Q2aofIpN|!8#&UpEsYTdVO4FG*_87Nc$t?U^9!!5>v+@Y6yKrc%tU zYeS~PT?kBVd`=D3V*9<|i_KN-LUKxUhw{9?0Y$iWEy#jgfA(j{NEY7&@t6mrz_0blX%xwlOu>h3JevDamAEmR?72Ph z*c5%>NwHF+TX-2AQ_XeRrOeqlv)Q$pGid?Zcwy4C%V(t2;VaG3J-pg4eHlb+w9pyb zr{QQx3>(v$yeMaBuaPP<9@J$cjnvCbR=l;)tkmbZ)IW~g7RG!-PSs|q&9O#K?Y_{mimO_}S|N(0jM*I>GcR1LuM6oyD%v=! zCzlSasLi|m^GZOR%egGX%!*%Hb)}D%jLUfHDK}s=?wv$ky;UsS;hNMuZtD`J9oF>J zUA#AAIn~T9#%O!hYn$Yxz?Mu--NbI}uprjpH_mTNPgFj2bNt= zlA~BAqsY;kt)l`z@C5J5H~V?Go5Q+`={}r4n*I)@ot}dy4(i9tUrX#?E?%u)>haqO z+`)~#Or5<;EeN!3>tLJQy1wf#zlFX&ble=>XN44yrE@Dyi_@*H};P{I{tZYO!B0JXQur4BhSk{_YCM!6)j$q$#on zu2Ko!_N!{bC+zPL-okh9*)hz@Kl949>-WG4_(~dItX+dt6)CRG%P4N~H{DB%k8;#n zt+=Nuz5Vf$-^_rp#571aNWw&NsF--jC4gtWzqQd?T&)y>6GH+jxpYQV0;^M!*uf+?1{9YJ5_yR`4g)kaA zgb^bK#E29l+JI=oqQ;CFV_f8DBcw`0CY5WJut_L<$==T!cuG#f%wuDDwC*wu$ z!(}6zJ9GXF`iK$Hq>q?Bjrs`w64k7eAaVT~$?GIXlGwhDTS*cnynFlR-K2>U;lYas zU(y8mlI6^sGZ9oMx*i3%BtC;>{!IB|c7EOTAM03qG)kLFBHwbnEPC5=YXihriOc=pBE3o5EJR07^LOve4 zAW%OA1vC&s2JM58LMkTo&_fbcR1pjpc|;>eHI9U1NF|kY(n%_{1msIG4GB|CH|%g^ zPB`h5gHK2Wr4vz2DU}otR4x@&R8wu)LseCEnblTW0pSCgW|kRN5I>y7CJ=7930Is$ z%rzHYcKWr~Ux4j7L}LDj{i#@Ej2W?5WSA8}C}x{wwy0;IeMZ`7l16&kYL>EQscf~W zX4`DD;g;KOqW(7AaKssxT&l`7$J}$SN>^QVi_D50ciUa^og|)cBHnoAm4aS+?5*dX zd$k-3-+cDr_sf3!3FBWf00!6$Hq%^7&4Sk~=uNi}iX)*p=!|=gg)CgCVLbS(;9gpo!bf%NacIhy1nN+kX0QjkR6q-0GwISH{)KuJmE#7Rx5 zB~)BeWffLfiCJbdHsdwUxVr8r(uHqDQM4+5jvTn zn<0v*W=1>u=>DUWj+R<#m##*eZMDVbTGgQ1rW>hR2Un_b$f=qftF1x@Di%U-dsB%8~8$}W3fe!~nNt$!SBu*`ti5Lk_Y2y&YZ#1j8g1rwY&pj6kS^b!4Ml_-NAFWxVNkcj*rjP zhAOYA{z`1iaTVF3vk0`QO*@H@1lzjvHn_>HSH3ERd4k0XV!6UtvuGhLk_9-yIg4=6 zDx5NyK`jAoYa0mKVYj?hISGYpT;(X&xjN@L&)q|G_4o(8N`yLsn22>OYEeY=wJ#a< zt9Cc4U5<8?yWOp%cfV^G!yX1Pos4l_TZ*)M36S&aVjH#E*1?SGtE8l{|OngSjWHd5=< z0v)I|-w?-Cs8UYYC@6>vmQ4{F+~C@{gG*eAP;MpsmEBU2LcO(zZ+@c>-~!jI!S$#9 zKQ`O|2dKaS04Yv~i{qg;B=;@K3DI&zB!@ROhs1Zx19VJmVm|^xkPw}yUaPa0>t2V& zipb7iUKH5Cz<98NjWJ=r8{95tv>`J<+w@2%N21Qo#W6Fndn4yo(_t9O_4kCb;W)0i$?y04M~jz zX3vrE2#mZ-2|ru1Ff%&rjA<+=lqlA`iz#J#b9`v_!Zgu5c8`y1Ds7wIR6as_G^DHr zXghkq{PdG~{BqJG_`Vp-%`Ri??`qw|22GFKW!xU?#w$oDj^lDj4C8Bdn@be;LeS zZPkTcg-;BVIm2a+m8^$zrZlN#P5MTztqckxT>JaY%l#J~0S+*T@ajYo?Ukb)1k*w!k8OKMlU>yYw#$Bd-yuvbby$rRbQ zh-$V>pWVp-3Q*e9J|NVpUA5Z$6l*{w)s>ZSnr>|SEbx!RQ{dRaHD zzPr3^MwXku3g@sglbP-{#(S3m_`nN(@PseC;SZ1a#4CRBjBmW-9}oG+OMdc{ue{|i VkNM1Ne)F8~yyrg;dd&v{06RP2#{B>Q literal 0 HcmV?d00001 diff --git a/docs/toolkit/manual/box.gif b/docs/toolkit/manual/box.gif new file mode 100644 index 0000000000000000000000000000000000000000..5b9cfcdf92632c45241707f74908f24fa30fc7c0 GIT binary patch literal 59 zcmZ?wbhEHb + + + + + + + + + + + + + + + + + +
Copyright © 2001 - 2007 SILC Project
+ SILC Project Website		 + SILC Toolkit Reference Manual
+ Index
+ + +
+ + + + + + + + + + + + + + +
+ + + +
+
+ + + +SILC Toolkit Reference Manual
+ + +SILC Crypto Library
+    Introduction to SILC RNG
+    SILC RNG Interface
+    SILC Cipher API
+    SILC PKCS API
+    SILC Public Key API
+    SILC PKCS #1 API
+    SILC Hash Interface
+    SILC HMAC Interface
+SILC Core Library
+    SILC Authentication Interface
+    SILC Message Interface
+    SILC Channel Interface
+    SILC Command Interface
+    SILC Notify Interface
+    SILC Status Types
+    SILC Modes
+    SILC ID Interface
+    SILC Argument Interface
+    SILC Attributes Interface
+    Packet Engine Interface
+    SILC Public Key Payload Interface
+SILC Key Exchange Library
+    SILC SKE Interface
+    SILC Connection Authentication Interface
+SILC VCard Library
+    SILC VCard Interface
+SILC Math Library
+    SILC MP Interface
+    SILC Math Interface
+SILC Client Library
+    Using SILC Client Library Tutorial
+    Arguments for command_reply Client Operation
+    SilcStatus Error Arguments in command_reply Client Operation
+    Arguments for notify Client Operation
+    Unicode and UTF-8 Strings in Client Library
+    Client Library Interface Reference
+    Client Entry Interface Reference
+SILC ASN.1 Library
+    SILC ASN.1 Interface
+    SILC BER interface
+SILC HTTP Library
+    SILC HTTP Server Interface
+    SILC HTTP PHP Translator
+SILC Utility Library
+    Basic Types and Definitions
+    Data Buffer Interface
+    Data Buffer Format Interface
+    Hash Table Interface
+    Memory Allocation Interface
+    Data Stack (memory pool) Interface
+    Finite State Machine Interface
+    Thread Interface
+    Mutual Exclusion Lock Interface
+    Condition Variable Interface
+    Atomic Operations Interface
+    Network (TCP and UDP) Interface
+    Scheduler Interface
+    Asynchronous Operation Interface
+    Abstract Stream Interface
+    Socket Stream Interface
+    File Descriptor Stream Interface
+    File Utility Functions
+    String Utility Interface
+    Snprintf Interface
+    UTF-8 String Interface
+    Stringprep Interface
+    Utility Functions
+    List Interface
+    Dynamic List Interface
+    MIME Interface
+    Time Utility Functions
+    Logging Interface
+    Config File Interface
+SILC Key Repository Library
+    SILC SKR Interface
+SILC Application Utility Library
+    SILC Application Utilities
+    SILC ID Cache Interface
+SILC SFTP Library
+    SILC SFTP Interface
+    SFTP Filesystems Interface
+ +
+Resource Links +
+SILC Project Website
+SILC Protocol Documentation
+SILC White Paper
+SILC FAQs
+ + +



+
+ 		+ + + + +
+
+Building the Toolkit + +
 
+SILC Toolkit works on various platforms, such as on several Unix systems and +on Windows. Building of the Toolkit on some platform may differ from the +other. This document describes how to build the Toolkit from the sources, +to create linkable libraries and binaries, on all platforms the Toolkit +support. + +
 
+The building instructions for all platforms are also included in the Toolkit +package. Please refer to the INSTALL file for general building instructions +for Unix systems, README.WIN32 for building on Windows systems, and +README.MACOSX for building on Mac OS X. + +
 
+
  • Building on Unix & Linux
    +
  • Building on Windows
    +
  • Building on Mac OS X +
  • Building on Symbian OS + +
     
     
    +Building on Unix & Linux + +
     
    +Building the Toolkit on Unix will produce binaries of all libraries, and +SILC Client and SILC Server. The Toolkit package includes also Client and +Server as an example applications, and they are compiled automatically. +The libraries are compiled to provide staticly linkable libraries. Two +libraries are produced: libsilc.a and libsilcclient.a. The libsilc.a includes +everything else except the Client library. The libsilcclient.a includes +only the Client library. + +
     
    +To build Toolkit on Unix systems, give commands: + +
     
    + +./configure
    +make +     + +
     
    +On some systems you may need to give "gmake" command instead of "make". The +./configure can take several options as arguments. To see them all give +command: + +
     
    +./configure --help + +
     
    +The most important configuration options you may consider to use are: + +
     
    +--enable-debug + +
     
    +If you would like to enable the debugging for the compiled binaries +you can give this option to the `configure'. It is recommended to use +this option when you are doing development with Toolkit. It is helpful +to enable run-time debugging. + +
     
    +--with-gmp[=DIR] + +
     
    +If you wish to use GMP library for arbitrary precision arithmetic +library instead of using the MPI library included in the package, you can +give the --with-gmp[=DIR] option to the `configure'. The DIR is the upper +path in your system which contains lib/ and include/ for GMP library. + +
     
    +--with-iconv[=DIR] + +
     
    +If your system doesn't provide iconv() function in its native libraries +(usually libc) or if this function is broken (e.g. older Solaris systems), +you may want to use libiconv instead. The DIR is the upper path in your +system which contains lib/ and include/ for libiconv (e.g. /usr/local). + +
     
    +--without-pthreads + +
     
    +If you do not want to compile the programs with POSIX multi-threads support +you can give --without-pthreads option. This will disable the SILC Thread +API and SILC Mutex API. Furthermore if SILC Thread API is used when this +option is used, the routines work, but do not work in threads (are run +in the calling process and can block the process). + +
     
    +--disable-asm + +
     
    +If you have trouble compiling the assembler optimized code in the +package or does not want to use them, you can give the --disable-asm +option to the `configure' script. This will assure that assembler +optimized code is not compiled in. + +
     
    +--enable-ipv6 + +
     
    +The `configure' will attempt to check for IPv6 support in your system. +However, if it fails, but you still want to compile in the IPv6 support +you can give --enable-ipv6 option to force the IPv6 support. + +
     
    +After compilation you can install the Toolkit into your system by giving +the command: + +
     
    +make install + + +
     
     
    +Building on Windows + +
     
    +The Toolkit can be compiled several different ways on Windows. However, +this document describes the method to build the Toolkit to produce native +Win32 binaries. The Toolkit package can also be compiled on Cygwin and +MinGW. For these systems please refer to the README.WIN32 file in the +Toolkit package. + +
     
    +The Toolkit package includes ready MSVC++ Workspace files, that will +automatically compile the Toolkit. The MSVC++ workspace and project files +resides in the win32/ subdirectory of the Toolkit package. The `silc.dsw' +file is the workspace file that automatically supports compiling the Toolkit +and to generate the SILC Core DLL and SILC Client DLL libraries. + +
     
    +The SILC Core DLL is named as libsilc and will generate libsilc.dll, and +the SILC Client DLL is named as libsilcclient and will generate +libsilcclient.dll. Both of the projects also automatically generates +libsilc.lib and libsilcclient.lib import libraries that may be used to +link against a client application. + +
     
    +Generally you do not need to do any specific settings to compile the +Toolkit. However, you must compile the libsilc before compiling the +libsilclient, since the SILC Client DLL depends on the SILC Core DLL. +You may compile the DLLs as either Release or Debug version. Just select +the preferred method of compilation. The Debug version will compile the +SILC Toolkit with run-time debugging support, which is recommended when +doing development with the Toolkit. + +
     
     
    +Building on Mac OS X + +
     
    +Building the Toolkit on Mac OS X is almost identical on compiling on Unix +system. The reason for this is that the Mac OS X is Unix based operating +system. To build the Toolkit on Mac OS X, give the following commands: + +
     
    + +setenv CFLAGS -no-cpp-precomp
    +./configure powerpc
    +make +     + +
     
    +The ./configure can take several options as arguments. To see them all give +command: + +
     
    +./configure --help + +
     
    +If you do not want to compile the applications, or they do not compile on +your system, you can also choose to compile only the libraries, and skip +all applications. In this case, before giving the "make" command, go +to the lib/ subdirectory, and give "make" command there: + +
     
    + +cd lib/
    +make +     + +
     
    +After compilation you can install the Toolkit into your system by giving +the command: + +
     
    +make install + +
     
     
    +Building on Symbian OS + +
     
    +The build environment for Symbian OS requires Carbide.c++ and MS Windows. + +
     
    +Download the freely available Carbide.c++ from Nokia at +http://forum.nokia.com. The exact +hyperlink location changes often, so it is not referenced here. It is +usually under "Tools and SDKs" link. + +
     
    +After installation a web browser is opened automatically by the +Carbide.c++ installer. Follow its instructions by installing the Perl, +CTags and the SDK. Perl and the SDK are required, but CTags is +optional and if necessary can be omitted. + +
     
    +The SILC Toolkit is generic C and C++ code and should work with any +SDK. If you don't have SDK already installed, install the latest +version you can find. The links to SDKs are found in the Carbide.c++ +instructions after installation. If you already have SDK in your +system, you should use that. + +
     
    +After installation import the SILC Toolkit project to Carbide.c++ from the +symbian/ subdirectory in the SILC Toolkit package. + +
     
    +Please read the README.SYMBIAN from the SILC Toolkit package for complete +building instructions. +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/command_reply_args.html b/docs/toolkit/manual/command_reply_args.html new file mode 100644 index 0000000..2e87623 --- /dev/null +++ b/docs/toolkit/manual/command_reply_args.html @@ -0,0 +1,615 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Command Reply Arguments + +
     
    +The SILC Client Library 'command_reply client operation (which is part of the + +SilcClientOperation callback functions) returns command replies +from the SILC Server for commands that the client has earlier sent to the +server. The 'command_reply' client operation implementation has a variable +argument list to deliver SilcCommand +specific arguments to the application. This document describes these +arguments for all command replies to help SILC client software developers +to process them. + +
     
    +NOTE: The following list of command reply arguments are sent when +the command was executed successfully. If an error occurred, the +`command_reply' client operation's 'success' argument is FALSE, and the +'status' argument includes the error status. In this case the arguments +returned are dependent of the 'status' argument. See all +SilcStatus error arguments for these +arguments. + +
     
     
    +command_reply Client Library operation + +
     
    +The 'command_reply' client operation callback function prototype is as follows: + +
     
    + +   +void (*command_reply)(SilcClient client, SilcClientConnection conn,
    + SilcCommand command, SilcStatus status,
    + SilcStatus error, va_list ap); +     + +
     
    +The first argument 'client' is the SILC Client Library context, the 'conn' +is the context for the connection to the remote server, the 'cmd_payload' +is the raw SilcCommandPayload and application usually ignores it, the +'success' boolean value indicates whether the earlier command was a success +or not, the 'command' is the command reply enumeration, and the 'status' +indicates the status of the command reply. If 'success' is FALSE then +'status' includes error status (see SilcStatus +error arguments). + +
     
    +Rest of the arguments are 'command' specific and implementation should +handle them by the SilcCommand for example in a switch statement. +The commands are defined in lib/silccore/silccomand.h header file. A short +example: + +
     
    + +  switch(type)
    +    {
    +    case SILC_COMMAND_WHOIS:
    +    ...
    +    break;
    +    case SILC_COMMAND_WHOWAS:
    +    ...
    +    break;
    +    case SILC_COMMAND_NICK:
    +    ...
    +    break;
    +    ...
    +    } +     + +
     
     
    +Arguments + +
     
    +The following table describes all commands and arguments that the client +library sends in the 'command_reply' client operation to the application. +By default all arguments that the library sends to application are valid +pointers. However, it is possible that some pointers may be NULL. If +this is the case it is separately mentioned that the argument may be NULL. +In this case application must ignore that argument. + +
     
    +The 'command_reply' arguments for successful SilcCommand replies are as +follows: + +
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionVariable Arguments
    SILC_COMMAND_WHOIS +Returns information about user. The following pointers may be NULL: 'channels', +'fingerprint', 'channel_usermodes' and 'attrs'. If 'fingerprint' is valid its +length is 20 bytes. If 'channels' is valid each entry in the list is +SilcChannelPayload. If the `channel_usermodes' is valid then the table +has as many entries as there are entries in the `channels' list, and the +first entry in the table is the user mode on the first channel in the +`channels' list. The `channel_usermodes' is the table of the user's modes +on the joined channels. The 'attr' is the Requested Attributes that may +have been returned by the client and it can be parsed by traversing the +SilcDList and using silc_attribute_get_attribute function. Each entry in +the list is SilcAttribute. +SilcClientEntry client_entry, char *nickname, +char *username, char *realname, SilcDList channels, SilcUInt32 usermode, +SilcUInt32 idletime, unsigned char *fingerprint, SilcUInt32 *channel_usermodes, +SilcDList attrs +
    SILC_COMMAND_WHOWAS +Returns history information about user. The 'client_entry' and 'realname' +may be NULL. +SilcClientEntry client_entry, char *nickname, +char *username, char *realname +
    SILC_COMMAND_IDENTIFY +Returns information about user, channel or server. This is similar to +WHOIS command but does not return so much information and can be used to +get information about channels and servers too. Application should ignore +this command reply. The 'name' and 'info' may be NULL. +void *entry, char *name, char *info +
    SILC_COMMAND_NICK +Returns the new Client ID and new nickname inside the SilcClientEntry. +The `old_client_id' is the old Client ID used by the client before the +nickname was changed. The `nickname' is the new nickname. Note that, +when user changes nickname SILC_NOTIFY_TYPE_NICK_CHANGE is not delivered +to application. Instead this SILC_COMMAND_NICK command reply is delivered. +SilcClientEntry local_entry, char *nickname, +const SilcClientID *old_client_id +
    SILC_COMMAND_LIST +Returns the list of channel in the SILC network. Each call of command reply +returns one channel. This means that the command reply is called multiple +times to return list of channels. The 'channel', 'channel_name' and +'channel_topic' may be NULL. However, the 'channel' and 'channel_name' +are NULL only if there are no channels in the network. In this case +this reply is called once with all arguments set to NULL. Application +must be able to handle this situation correctly. +SilcChannelEntry channel, char *channel_name, +char *channel_topic, SilcUInt32 user_count +
    SILC_COMMAND_TOPIC +Returns the topic of the channel. +SilcChannelEntry channel, char *topic +
    SILC_COMMAND_INVITE +Returns the invite list of the channel. Called also even if invite list +was not modified but SILC_COMMAND_INVITE command was used to invite a user +into a channel. In this case the invite list is not returned by the +server and 'invite_list' is NULL. The 'invite_list' is SilcArgumenPayload +which contains one or more arguments, each is one invite list entry. The +entries can be retrieved with silc_argument_get_first_arg, +silc_argument_get_next_arg, silc_argument_get_arg_type and +silc_argument_get_decoded functions. +SilcChannelEntry channel, +SilcArgumentPayload invite_list +
    SILC_COMMAND_KILL +Called after killing a client. Returns the client that was killed. +The `client_entry' may be NULL. The `client_entry' will become invalid +after the command reply has returned from application. The +SILC_NOTIFY_TYPE_KILLED will not be delivered for clients that you killed. +SilcClientEntry client_entry +
    SILC_COMMAND_INFO +Returns information about the server user is connected to. +SilcServerEntry server, char *server_name, +char *server_info +
    SILC_COMMAND_STATS +Returns network statistics from the server. The `stats' structure contains +the statistics returned by the server. +SilcClientStats *stats +
    SILC_COMMAND_PING +Returns reply to earlier ping. There is no arguments to this reply. +none +
    SILC_COMMAND_OPER +Returns reply to earlier SILC_COMMAND_OPER command. There is no arguments +to this reply. +none +
    SILC_COMMAND_JOIN +Reply received when user joined a channel. The `channel_mode' contains +the current channel mode. The `user_list' is the user list on the channel +and may be traversed with silc_hash_table_get function. Each entry in the +`user_list' is SilcChannelUser structure, which contains the SilcClientEntry +and the client's mode on the channel. The library will free the list. +The `topic' is the current topic on channel or NULL if no topic is set. +The `cipher' is the encryption algorithm used on channel or NULL if it is +not available. The `hmac' is the HMAC algorithm used on channel or NULL if +it is not available. The `founder_key' is the channel founder's public key +or NULL if founder public key has not been set. The `channel_pubkeys' is +a list of channel public keys (for authentication on joining) or NULL if +they have not been set. Each entry in the list is SilcArgumentDecodedList +each containing one channel SilcPublicKey. The library will free the list. +char *channel_name, SilcChannelEntry channel, +SilcUInt32 channel_mode, SilcHashTableList *user_list, char *topic, +char *cipher, char *hmac, SilcPublicKey founder_key, +SilcDList channel_pubkeys, SilcUint32 user_limit +
    SILC_COMMAND_MOTD +Returns the Message of the Day from the server. The 'motd' may be NULL. +char *motd +
    SILC_COMMAND_UMODE +Returns the user mode after changing it. +SilcUInt32 user_mode +
    SILC_COMMAND_CMODE +Returns channel's mode after changing it. Optionally may also return +founder's public key when it was set. It may also return the channel +public key list when the list was altered. The 'founder_key' and +'channel_pubkeys' arguments may be NULL. The 'channel_pubkeys' is a list +of SilcArgumentDecodedList contexts which each contain one channel public +key. The library will automatically free the list. +SilcChannelEntry channel, SilcUInt32 mode, +SilcPublicKey founder_key, SilcDList channel_pubkeys, SilcUint32 user_limit +
    SILC_COMMAND_CUMODE +Returns user's mode on channel after changing it. +SilcUInt32 mode, SilcChannelEntry channel, +SilcClientEntry target_client +
    SILC_COMMAND_KICK +Called after kicking a client. Returns the client that was kicked from +the 'channel'. +SilcChannelEntry channel, SilcClientEntry client_entry +
    SILC_COMMAND_BAN +Returns channel's ban list. The 'ban_list' may be NULL. The construction +of that list is equivalent to invite list. See description of +SILC_COMMAND_INVITE command reply. +SilcChannelEntry channel, SilcArgumentPayload ban_list +
    SILC_COMMAND_DETACH +Called after being detached from the SILC network. The command reply delivers +the detachment data buffer `detach_data' that the application should save +for example into a file. The data will be needed when resuming back to +the network. When resuming the data is saved into SilcClientConnectionParams +structure and given as argument to silc_client_connect_to_server or +silc_client_key_exchange functions. +SilcBuffer detach_data +
    SILC_COMMAND_WATCH +Called after modifying the watch list in the server. There is no arguments +to this reply. +none +
    SILC_COMMAND_SILCOPER +Returns reply to earlier SILC_COMMAND_SILCOPER command. There is no +arguments to this reply. +none +
    SILC_COMMAND_LEAVE +Called after leaving the channel. Note that the `channel' will become +invalid after command_reply client operation returns. +SilcChannelEntry channel +
    SILC_COMMAND_USERS +Returns list of users in channel. The `user_list' may be traversed with +silc_hash_table_get function. Each entry in the `user_list' is +SilcChannelUser structure, which contains the SilcClientEntry and the +client's mode on the channel. +SilcChannelEntry channel, SilcHashTableList *user_list +
    SILC_COMMAND_GETKEY +Returns public key of client or server. The 'public_key' may be NULL. +The 'entry_type' is used to check what type of pointer the entry' is. For +SILC_ID_CLIENT SilcClientEntry and for SILC_ID_SERVER SilcServerEntry. +SilcIdType entry_type, void *entry, +SilcPublicKey public_key +
    SILC_COMMAND_SERVICE +Returns the service list in the server, or information on the accepted +and authenticated service. The 'service_list' maybe NULL if server does +not support any services. It is NULL also when 'name' is not NULL. The +'service_list' is a comma separated list of services the server supports. +The 'name' MAY be NULL also. The 'name' is the requested service, and it is +non-NULL only if server accepted and authenticated client's request. +const char *server_list, const char *service_name +
    + +
     
    +SILC protocol defines some additional commands but command replies to +those commands are not delivered to the application. Only the command +replies listed above are delivered to application. +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/dot.gif b/docs/toolkit/manual/dot.gif new file mode 100644 index 0000000000000000000000000000000000000000..5829b6e668973f411aa327e122ab4a6e62169946 GIT binary patch literal 71 zcmZ?wbhEHbWMyDwXkY+=|Ns9h{u6aBN=+ + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + +



    +
    +     		+ + + + +
    +
    + + +SILC Toolkit Reference Manual +
    + +Version: 1.1.11
    +Copyright © 1997 - 2014 The SILC Project
    +Updated: Tue May 6 13:34:38 EEST 2014 +     +


    +Welcome to the SILC Toolkit Reference Manual. The manual is a complete +developer guide and reference for the SILC application programmer. The manual +is intended for application programmers who would like to integrate the SILC +support into their application, and to create new SILC applications. +

    +The guide is especially targeted to SILC client application developers, and +provides full reference for the SILC Client Library, and a developer guide to +create new SILC client applications. +

    +The application programming interfaces are automatically generated from the +Toolkit sources, and the documentation is constantly evolving. New versions +of the Toolkit always delivers the latest version of this reference manual. + +


    +
  • Porting from Toolkit 1.0 to 1.1
    +
  • Introduction to the Manual
    +
  • Programming Conventions
    +
  • Building the Toolkit +
  • Platform Implementations + +

    +Guides & Tutorials +

    +
  • Client Library Guides & Reference +
  • Introduction to SILC Random Number Generator + +

    +Toolkit Reference +

    + +
  • SILC Crypto Library +
  • SILC Core Library +
  • SILC Key Exchange Library +
  • SILC VCard Library +
  • SILC Math Library +
  • SILC Client Library +
  • SILC ASN.1 Library +
  • SILC HTTP Library +
  • SILC Utility Library +
  • SILC Key Repository Library +
  • SILC Application Utility Library +
  • SILC SFTP Library +
  • Toolkit Index
    + +

    +Resource Links +

    +Please refer to these outside links for more information about the SILC +project and SILC Protocol. + +

    +
  • SILC Project Website
    +
  • SILC Protocol Documentation
    +
  • SILC White Paper
    +
  • SILC FAQ
    +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/index.tmpl b/docs/toolkit/manual/index.tmpl new file mode 100644 index 0000000..01aff02 --- /dev/null +++ b/docs/toolkit/manual/index.tmpl @@ -0,0 +1,98 @@ + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + diff --git a/docs/toolkit/manual/index_pic.gif b/docs/toolkit/manual/index_pic.gif new file mode 100644 index 0000000000000000000000000000000000000000..e84bec43d016bb069f017dfda7140222782af374 GIT binary patch literal 60 zcmZ?wbhEHb + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Introduction to the Manual +
     
    + +This document is designed to help you understand how the reference manual is +organized, how it can be used efficiently, and how to find the information +you need. + +
     
     
    +Target Audience + +
     
    +This Toolkit reference manual is targeted at application developers who +would like to add SILC support into their application, and to create new +SILC based applications. It is especially aimed at C and C++ programmers, +who would like to create SILC client applications, either based on command +line interface (CLI) or on graphical user interface (GUI). + +
     
     
    +Overview + +
     
    +The SILC Toolkit Reference Manual has collected the essential information +needed by application developers. The following guide and reference +information is included in this manual: + +
     
    +
  • Describing the documentation conventions
    +
  • Describing the Toolkit design
    +
  • Describing the SILC Protocol
    +
  • Describing the programming conventions and idioms
    +
  • Documenting the set of public APIs available for programmers
    +
  • Describing the usage of various libraries + +
     
    +You can download the latest SILC Toolkit from the +SILC Project Website, which includes the +latest version of the reference manual. The Toolkit package includes the +full sources of the Toolkit, and includes several example applications and +piece of example codes. + +
     
     
    +Using the Reference Manual + +
     
    +The API references are ogranized by libraries. Each library will include +list of interfaces it provides. Each of the interface in the library +provides list of public API items. Each of the item in the list is a hyper +link that opens the detailed page describing the API item. All API +references are automatically generated from the sources and they have a clear +structural layout. The references can provide cross links to other +references inside the specific interface or the specific library. + +
     
    +The list of the library interface items can also include links to guides +that describe the use of a specific library or interface. These are +intended as HOWTOs for programmers describing all aspects of the library +or interface. They make the application development easier by also providing +small examples. + +
     
    +All interfaces provided by the reference manual are public, and it does not +describe any internal or undocumented interfaces. Since the reference +manual is automatically generated, it is constantly evolving. It also +may omit some of the interfaces or libraries, that have not yet been +documented in the sources. + +
     
     
    +Document Layout + +
     
    +The document layout provides quick links to libraries, interfaces and +specific API items by including list of links in the left and/or right +side of the page in the web browser. These links can be used to directly +access the specific library, interface or API item. The link lists may include +other links to guides, and reference links to outside the reference manual +as well. + +
     
     
    +Reference Conventions + +
     
    +The structural layout of a API item describes the following information +about the item: + +
     
    +
  • Type. Types that can appear are Variable, Structure, Function. A name +that appears without type is constant, usually #define, enum or typedef. +Usually the source code of the constants are appended to the reference. + +
     
    +
  • Name. Describes the name of the item. All functions start with +silc_ prefix, macros start with SILC_ prefix, and type names +and structures start with Silc prefix. + +
     
    +
  • Synopsis. Functions also describe the synopsis of the function. + +
     
    +
  • Description. Each of the item is described in detail of what the item +does and how it can be used. + +
     
    +
  • Notes. Optionally the item may describe additional notes to the +detailed description. These usually describe various exeptions or other +important notes that the programmer should be aware of. + +
     
    +
  • Example. Optionally the item may include a piece of source code that +give short example of how the item may be used. + +
     
    +
  • See Also. Optionally the item may include list of links to other +items, or some other references that relate to the described item. + +
     
    +
  • Source. Optionally the item may include the actual source code from +the header file where the documentation was automatically generated. + +
     
    +Note that some of these informations are optional and not all API items +include all of these informations. + +
     
     
    +Reference Example + +
     
    +Please refer to this link for short example of the API item reference +layout: SILC Example API. + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/notifyargs.html b/docs/toolkit/manual/notifyargs.html new file mode 100644 index 0000000..1a0b71a --- /dev/null +++ b/docs/toolkit/manual/notifyargs.html @@ -0,0 +1,477 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +SilcNotifyType Arguments + +
     
    +The SILC Client Library 'notify' client operation (which is part of the + +SilcClientOperation callback functions) returns different kind of +notifications from the SILC server to the SILC client. The 'notify' +client operation implementation has a variable argument list to deliver +SilcNotifyType type specific arguments to the application. This document +describes these arguments for all notify types to help SILC client +software developers to handle the incoming notifications. + +
     
     
    +notify Client Library operation + +
     
    +The 'notify' client operation callback function prototype is as follows: + +
     
    + +  void (*notify)(SilcClient client, SilcClientConnection conn, +SilcNotifyType type, ...); + + +
     
    +The first argument 'client' is the SILC Client Library context, the `conn' +is the context for the connection to the remote server, and the `type' is +the notify type enumeration sent by the server. Rest of the arguments are +`type' specific and implementation should handle them by the +SilcNotifyType for example in a switch statement. The notify +types are defined in lib/silccore/silcnotify.h header file. A short +example: + +
     
    + +  switch(type)
    +    {
    +    case SILC_NOTIFY_TYPE_NONE:
    +    ...
    +    break;
    +    case SILC_NOTIFY_TYPE_INVITE:
    +    ...
    +    break;
    +    case SILC_NOTIFY_TYPE_JOIN:
    +    ...
    +    break;
    +    ...
    +    } +     + +
     
     
    +Arguments + +
     
    +The following table describes all notify types and arguments that the +client library sends in the 'notify' client operation to the application. +By default all arguments that the library sends to application are valid +pointers. However, it is possible that some pointers may be NULL. If +this is the case it is separately mentioned that the argument may be NULL. +In this case application must ignore that argument. The SilcNotifyType +arguments per notify type is as follows: + +
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionVariable Arguments
    SILC_NOTIFY_TYPE_NONE +A message from server that usually does not include any critical +information. Application may ignore this or display it for the user. +The 'message' argument may be NULL. +char *message
    SILC_NOTIFY_TYPE_INVITE +Sent to the client if the user is invited on a channel. The 'channel +argument may be NULL but the `channel_name' is always provided. +SilcChannelEntry channel, char *channel_name, +SilcClientEntry inviter +
    SILC_NOTIFY_TYPE_JOIN +Sent when someone joins to a channel. This is also sent whenever you join +a channel, in addition of receiving SILC_COMMAND_JOIN command reply. +SilcClientEntry joining_client, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_LEAVE +Sent when someone leaves (parts) the channel. +SilcClientEntry leaving_client, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_SIGNOFF +Sent when someone signoff the SILC network. The 'signoff_message' may be +NULL. The `signoff_client' is the client signing off. The `channel' is +the channel where the client was joined. The `channel' may be NULL. +SilcClientEntry signoff_client, char +*signoff_message, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_TOPIC_SET +Sent when the topic of a channel is set/changed. The 'setter_id_type' +is used to check what type of pointer the 'setter_entry' is. For +SILC_ID_CLIENT SilcClientEntry, for SILC_ID_SERVER SilcServerEntry and for +SILC_ID_CHANNEL SilcChannelEntry. +SilcIdType setter_id_type, void *setter_entry, +char *topic, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_NICK_CHANGE +Sent when someone changes their nickname. The 'client_entry' is the client +whose nickname is changed. The `old_nickname' is the old nickname and the +`new_nickname' is the new nickname. It has been already updated into the +`client_entry'. +SilcClientEntry client_entry, const char *old_nickname, +const char *new_nickname +
    SILC_NOTIFY_TYPE_CMODE_CHANGE +Sent when channel's mode has changed. The 'changer_id_type' +is used to check what type of pointer the 'changer_entry' is. For +SILC_ID_CLIENT SilcClientEntry, for SILC_ID_SERVER SilcServerEntry and for +SILC_ID_CHANNEL SilcChannelEntry. The 'mode' is the mode mask after the +change. The `cipher_name' is the cipher set for the channel. +The `hmac_name' is the HMAC set for the channel. The `passphrase' +is the passphrase that was set for the channel. The `founder_key' is the +founder's public key when it was set for the channel. The `channel_pubkeys' +is a list of SilcArgumentDecodedList contexts each containing one channel +public key. The library will free the list automatically. The arguments +'cipher_name', 'hmac_name', 'passphrase', 'founder_key' and 'channel_pubkeys' +may be NULL. +SilcIdType changer_id_type, void *changer_entry, +SilcUInt32 mode, char *cipher_name, char *hmac_name, char *passphrase, +SilcPublicKey founder_key, SilcDList channel_pubkeys, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_CUMODE_CHANGE +Sent when a users mode on a channel has changed. The 'changer_id_type' +is used to check what type of pointer the 'changer_entry' is. For +SILC_ID_CLIENT SilcClientEntry, for SILC_ID_SERVER SilcServerEntry and for +SILC_ID_CHANNEL SilcChannelEntry. The 'mode' is the mode mask after the +change. The 'target_client' is the client whose mode was changed. +SilcIdType changer_id_type, void *changer_entry, +SilcUInt32 mode, SilcClientEntry target_client, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_MOTD +Message of the Day from the server. +char *motd +
    SILC_NOTIFY_TYPE_CHANNEL_CHANGE +Sent when a channel's Channel ID changes. It is possible that channel's +ID changes and this notify is sent by the server when this happens. +Usually application does not need to handle this notify type and may +safely ignore it when received. +SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_SERVER_SIGNOFF +Sent when a server quits the network. The 'clients' is a list of +SilcClientEntry pointers. Each client in the entry is one client signing +off from the SILC network. The library will free the list. The `server' +is the quitting server, and it is NULL if the server isn't cached in the +client library. +SilcServerEntry server, SilcDList clients +
    SILC_NOTIFY_TYPE_KICKED +Sent when a client (possibly our client) is kicked from a channel. The +'kick_message' may be NULL. If our client was kicked then 'kicked' is our +local SilcClientEntry pointer. +SilcClientEntry kicked, char *kick_message, +SilcClientEntry kicker, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_KILLED +Sent when a client (possibly our client) is killed from the network. The +'kill_message' may be NULL. If our client was killed then 'killed' is our +local SilcClientEntry pointer. The 'killer_type' is used to check what +type of pointer the 'killer' is. For SILC_ID_CLIENT SilcClientEntry, for +SILC_ID_SERVER SilcServerEntry and for SILC_ID_CHANNEL SilcChannelEntry. +SilcClientEntry killed, char *kill_message, +SilcIdType killer_type, void *killer, SilcChannelEntry channel +
    SILC_NOTIFY_TYPE_ERROR +Sent when an error occurs while handling some operation (except command) +from the client. Application usually cannot handle this notify type and +may safely ignore it. +SilcStatus error +
    SILC_NOTIFY_TYPE_WATCH +Sent to notify some status change of a client we are wathing. The +SILC_COMMAND_WATCH is used to manage clients we are wathing and this +notify type is used to deliver information about that client. If the +client just changed nickname the 'new_nickname' includes the new nickname. +Otherwise this pointer is NULL. The 'user_mode' is the client's mode in +the SILC network. The 'notification' contains the notify type that +happened for the 'watched_client' (for example +SILC_NOTIFY_TYPE_NICK_CHANGE if the client changed their nickname). If +the `new_nickname' is NULL and `notification' is SILC_NOTIFY_TYPE_NONE the +`watched_client' has just joined the network. +SilcClientEntry watched_client, char *new_nickname, +SilcUInt32 user_mode, SilcNotifyType notification, SilcPublicKey +public_key +
    + +
     
    +SILC protocol defines some additional notify types but those notify types +are not delivered to the application. Some of those notify types are only +delivered between servers and routers and clients never receive them. +Only the notify types listed above are delivered to application. +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/platforms.html b/docs/toolkit/manual/platforms.html new file mode 100644 index 0000000..1b863d0 --- /dev/null +++ b/docs/toolkit/manual/platforms.html @@ -0,0 +1,273 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Platform Implementations + +
     
    +This document describes the implementation issues with different platforms +that the SILC Toolkit support. Some of the supported platforms does not +support all the features delivered with the Toolkit or they may behave +differently from other platforms. + +
     
    +
  • Unix & Linux Implementation
    +
  • Windows Implementation
    +
  • Mac OS X Implementation +
  • Symbian OS Implementation + +
     
     
    +Supported Platforms + +
     
    +SILC Toolkit supports by default all Unix and Linux platforms, Windows +platforms from Windows 2000 and newer, Mac OS X and Symbian OS. + +
     
     
    +Unix Implementation + +
     
    +All features and components delivered with the SILC Toolkit work on all +Unix and Linux platforms. There are no special Unix platform related +implementation issues with current version of SILC Toolkit. + + +
     
     
    +Windows Implementation + +
     
    +By default all features and components delivered with SILC Toolkit are +supported on Windows. However, there are some certain issues with the +Windows version of the SILC Toolkit. + +
     
    +
  • Some of the network routines do not support IPv6. + + +
     
     
    +Mac OS X Implementation + +
     
    +All features and components delivered with the SILC Toolkit work on Mac +OS X platform. There are no special Mac OS X platform related +implementation issues with current version of SILC Toolkit. + + +
     
     
    +Symbian OS Implementation + +
     
    +Symbian OS support in SILC Toolkit is still experimental. By default all +features and components delivered with SILC Toolkit are supported and +should work on Symbian. However, there are some issues with the Symbian +version of the SILC Toolkit of what Symbian developers need to be aware. + +
     
    +
  • The function silc_schedule on Symbian will allocate new Active +Scheduler Waiter and will block the calling thread. The caller should +allocate Active Scheduler before calling silc_schedule. + +
  • When adding timeout tasks to SILC Scheduler the SILC Scheduler is woken +up after the timeout task has been added. This allows adding of the +timeout tasks from Symbian active objects outside the SILC Scheduler loop. +On other platforms this wakeup operation is not performed. + +
  • Adding fd task to SILC Scheduler will not schedule the fd for any +operation. Instead, programmer should use SILC Socket Stream API and SILC +Fd Stream API on Symbian when dealing with file descriptors and sockets. +These APIs provide asynchronous notification when data is available and can +be written. + +
  • The function silc_thread_create on Symbian will install Active +Scheduler and allocate Cleanup Stack for the new thread. The created +thread always shares heap with the parent thread. +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/porting.html b/docs/toolkit/manual/porting.html new file mode 100644 index 0000000..f87ac6e --- /dev/null +++ b/docs/toolkit/manual/porting.html @@ -0,0 +1,872 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Porting from Toolkit 1.0 to 1.1 + +
     
    +This documents describes the differences between the SILC Toolkit 1.0 and +1.1 and should help application programmers to port their SILC applications +to the new Toolkit version. + +
     
    +
  • General
    +
  • Platform changes +
  • Client library
    +
  • Utility library
    +
  • Application utility library +
  • Crypto library +
  • Key Repository library +
  • VCard library +
  • HTTP library +
  • ASN.1 library + +
     
    +

    General changes

    + +The main SILC Toolkit header file has changed its name from silcincludes.h +to silc.h. The first task in porting from 1.0 to 1.1 is to change these +filenames in your source tree. + + +
     
    +

    Platform changes

    + +The Windows support has been made better by improving the SILC scheduler +and network routines. Calling silc_net_win32_init and silc_net_win32_uninit +is not needed anymore. The network routines on Windows are enabled +automatically. + + +
     
    +

    Client library, lib/silcclient/

    + +The client library in Toolkit 1.1 has been partially rewritten. It was +rewritten to work out some technical issues and to increase performance +and decrease memory consumption. The client library API has also faced +some changes, altough most of it has remained the same. Most major change +in the client library is that is now fully supports multiple threads. In +the past making multithreaded SILC client application was always a bit hard +but with Toolkit 1.1 it should be relatively straightforward. + +

    SilcClientOperations structure

    + +The SilcClientOperations structure has changed significantly. It no longer +has `connected', `disconnected' and `failure' function pointers. Instead a +new SilcClientConnectCallback has been defined that is given as argument to +functions like silc_client_connect_to_server, silc_client_connect_to_client +and silc_client_key_exchange (last two being entirely new functions in the +API). That callback is called when connection is established and when it +is disconnected, or if a protocol failure occurred during connecting. That +callback also delivers a detailed error information when error occurs. New +connection related status types in SilcClientConnectionStatus has also been +added, see the API for the details. + +
     
    +Also the `detach' client operation function pointer has been removed. Instead +the detachment data is now simply delivered in the SILC_COMMAND_DETACH +command reply. + +
     
    +Some of the remaining client operation function pointers have changed a bit. +Most major change is the `command' operation now having the arguments that +user gave on the user interface sent back to application. The `command_reply' +does not anymore include the SilcCommandPayload as an argument. Also the +variable argument lis is now delivered as va_list. Also the boolean +success indicator is removed and SilcStatus error argument instead is telling +the exact error if the SilcStatus status is other than SILC_STATUS_OK. + +
     
    +The `get_auth_method' client operation now includes the authentication method +that has been resolved from the remote server. The application no longer +needs to resolve it and the function silc_client_request_authentication_method +has been removed from the API. + +
     
    +The `verify_public_key' client operation now include the SilcPublicKey pointer +instead of the public key in raw encoded form. Also the connection type +argument has changed to SilcConnectionType. + +
     
    +The `key_agreement' client operation now includes a new protocol argument +which tells whether the key agremeent is supposed to be done on TCP or on +UDP transport. The new Toolkit 1.1 supports both. + +

    SilcClient

    + +The SilcClientParams includes new fields and some fields have been removed +or moved to other places. All connection timeout related fields have been +moved to SilcClientConnectionParams. The nickname_parse callback pointer has +also been removed from SilcClientParams. The Toolkit 1.1 now automatically +parses formatted nicknames. + +
     
    +The new field boolean `threads' can be used to tell whether the new SilcClient +is to use multiple threads or not. If threads support has been compiled in +and that field is set to TRUE then the client library will create new thread +for each new connection to a remote host. If you are going to use several +connections or some of the connections are high throughput connections (like +multimedia connections) then using threads is recommended for performance. +Note that your application needs to be multithreaded and, if necessary to, +perform concurrencly control in client operation callbacks which may be +called from multiple threads at the same time for different connections. +However, it is always guaranteed that for one connection the client +operations cannot be called from multiple threads. The multithreads +support in Toolkit 1.1 client library means that each new connection and +everything related to that connection is handled in own dedicated thread. + +
     
    +The silc_client_init function now takes several new arguments. It now takes +the username, hostname and realname as argument that used to be required +by the application to update directly to SilcClient pointer. This is not +longer required. Also the nickname is no longer required to be put to +SilcClient context as it has been made SilcClientConnection specific. +The function also takes a SilcClientRunning callback as argument which will +be called when the client library is running. Only after the callback is +delivered may the application start using other client library API functions. +For example, connecting to a server will fail if it is performed before +the SilcClientRunning callback is called. The callback is called after the +silc_client_run or silc_client_run_one has been called. + +
     
    +The silc_client_stop function takes new SilcClientStopped callback as +argument, and it will be called after the client library has been completely +stopped. The application should not quit before that is called in order +to clean up all resources allocation by the client library. + +
     
    +It is also not required to put the public key pair (SilcPublicKey and +SilcPrivateKey) into SilcClient. They have been made connection specific so +you simply give them as argument when you create new connection. This way +it is now possible to use different key pairs with different connections, +one that was not possible in Toolkit 1.0 without creating new SilcClient +instance for each new connection. + +

    SilcClientConnection

    + +The SilcClientConnection represents connection to a remote host. In new +Toolkit 1.1 this structure now includes all connection related data and +no connection related data is anymore included in SilcClient. For this +reason it is no longer necessary to create multiple SilcClient instances +just because you want to create multiple connections. + +
     
    +The SilcClientConnectionParams structure has many new fields. This structure +is given as argument to any function that is able to create a new connection +or to create a network listener or to create a new SILC sessions. See the +API documentation for all the details but the following one field of special +relevance when creating new SILC server connections. The nickname field is +now included in this structure and it is the nickname user would like to +initially use in the SILC network. + +
     
    +The functions silc_client_connect_to_server, silc_client_connect_to_client +and silc_client_key_exchange can all be used to create new SILC session with +a remote. To connect SILC server use silc_client_connect_to_server. You +now give the SilcClientConnectionParams as argument which includes the +nicknameuser wants to use, you now can give the public key pair as argument that is +to be used in the connecting. The new SilcClientConnectCallback will be +called once the connection has been established and it delivers the +SilcClientConection context to the application. It will be later called +again to indicated disconnection from the remote host. These functions +now return SilcAsyncOperation context which can be used to cancel the +connecting, if necessary. In the past canceling connection was not possible. + +
     
    +
    +SilcAsyncOperation op;
+SilcClientConnectionParams params;
+
+memset(¶ms, 0, sizeof(params));
+
+/* Set nickname user wants to use */
+params.nickname = nickname;
+
+/* Set perfect forward secery for key exchange */
+params.pfs = TRUE;
+
+/* Example of creating, and then canceling a connection */
+op = silc_client_connect_to_server(client, params, public_key, private_key,
+                                   remote_host, remote_port, connection_cb,
+				   app_context);
+if (!op) {
+  fatal("Connecting failed immediately"));
+  exit(1);
+}
+
+...
+
+/* Cancel connecting.  After canceling the `connection_cb' will not be
+   called. */
+silc_async_abort(op);
+
    + +
     
    +The old function silc_client_start_key_exchange has been replaced with +silc_client_key_exchange function. Semantically it is equivalent to +silc_client_connect_to_server but it does not create new connection. Instead, +it accepts SilcStream as argument which is already established connection +to a remote host and it merely starts the key exchange. See an example +in the API documentation on how to use the silc_client_key_exchange, if +your application wishes itself to create connection instead of using the +client library to do it. + +The functions silc_client_add_connection, silc_client_del_connection and +silc_client_del_socket has been removed. They are no longer needed. + +

    Entries

    + +Just like in Toolkit 1.0 we now have SilcClientEntry to represent user, +SilcChannelEntry to represent channel and SilcServerEntry to represent +server. In the past these structures and all API functions that dealt +with them were in silcclient.h file. They +are now in silcclient_entry.h in +Toolkit 1.1. + +
     
    +As an general convention each of these new entries now are reference +counted and they have locks when using them in multithreaded application. +Even in one-threaded application the application must always acquire a +reference of the entry if it wishes to save the entry pointer in the +application. The reference must be released once the entry pointer is +not needed anymore. This ensures that the library cannot free the entry +pointer underneath the application. An own API for taking and releasing +the reference is in Toolkit 1.1. + +
     
    +
    +/* Take reference of the client entry I save to my own context. */
+my_context->client_entry = silc_client_ref_client(client, conn, client_entry);
+
    + +
     
    +If multiple threads are used and application wants to access the entry it +must always first lock the entry. After application has read the information +it needs from the entry it must release the entry lock. The entry lock +should be held only for short periods of time and failure to release the +lock will result into deadlock. An own API for taking and releasing the +entry lock is in Toolkit 1.1. If you application is not multithreaded +you do not need to use the entry locking. + +
     
    +
    +/* Read data from client entry in multithreaded environment */
+silc_client_lock_client(client_entry);
+fprintf(stdout, "%s\n", client_entry->nickname);
+fprintf(stdout, "%s\n", silc_id_render(SILC_ID_CLIENT, &client_entry->id));
+silc_client_unlock_client(client_entry);
+
    + +
     
    +From the entries all unnecessary information for application has been either +removed or moved to internal structure that is not accessible by the +application. As a result the entry structures are much smaller and cleaner. + +
     
    +The SilcClientEntry now includes nickname_normalized field and it is the +normalized version of the user's nickname, in case application needs it. +It is also guaranteed in Toolkit 1.1 that the nickname inside SilcCientEntry +is always valid nickname. + +
     
    +The SilcChannelEntry now includes new channel_pubkeys list, which includes +the channel public keys if they have added to the channel. This information +was not present in Toolkit 1.0. + +
     
    +The SilcServerEntry now includes new field public_key, which is the server's +public key if we have resolved it. This information was not present in +Toolkit 1.0. + +
     
    +In Toolkit 1.1 it is now easier to search and resolve entries. As a new +feature it now also possible to search and resolve server entries from the +SILC network. See the API documentation for all the details on searching +entries from the client library cache and from the SILC network. + +

    Sending/Receiving messages

    + +Sending messages has not much changed from the Toolkit 1.1. In Toolkit 1.1 +the message may now safely be sent in from multiple threads for same client +or for same channel. In case the message are digitally signed the hash +function used in the signature computation must now be given as argument. +If this is done in multiple threads, each thread must use different SilcHash +context because SilcHash does not support multiple threads. Simply allocate +new SilcHash for each thread where you send digitally signed messages. + +
     
    +Receiving message is same as in Toolkit 1.0. You receive private_message +or channel_message client operation. It is always guaranteed that even in +multithreaded application the messages are received in one thread. You need +concurrency control in your application only if you access shared data in +your client operation callbacks. + +
     
    +In Toolkit 1.1 as a new feature it is also possible to wait for incoming +private messages in a thread. New function silc_client_private_message_wait +can be used to block the calling process or thread until private message +for the specified client is received. + +

    Calling and sending commands

    + +Just like in Toolkit 1.0 in Toolkit 1.1 you can call command implemented +inside the client library with silc_client_command_call. The command_reply +client operation will be called once the command reply has arrived. + +
     
    +As a major change in semantics of sending commands with the +silc_client_command_send function is the way the command reply is handled +in Toolkit 1.1. In the new Toolkit the command_reply client operation will +not be anymore called for commands that has been sent with +silc_client_command_send. The command_reply client operation is called only +when silc_client_command_call function is used. With silc_client_command_send +you can give the command reply callback, SilcClientCommandReply, as argument, +and it will be called for each command reply that is received from the +server. + +
     
    +Just likein 1.0 in 1.1 it is also possible to attach to pending commands +by using silc_client_command_pending. As a difference to 1.0 the command +identifier is not anymore available to application from the +SilcClientConnection context. Instead the silc_client_command_call and +silc_client_command_send return the command identifier, and application needs +to save it in order to be able to attach to it at later time. However, +this feature is not expected to be very important for application +programmers as the new silc_client_command_send already includes the +command reply callback. + +
     
    +
    +Comparison between 1.0 and 1.1
+
+Toolkit 1.0:
+/* Send ping command.  The reply will be in the attached command reply
+   and in the command_reply client operation. */
+silc_client_command_send(client, conn, SILC_COMMAND_PING, ++conn->cmd_ident,
+			 1, 1, server_id, server_id_len);
+silc_client_command_pending(conn, SILC_COMMAND_PING, conn->cmd_ident,
+                            ping_command_reply, context);
+
+Toolkit 1.1:
+/* Send ping command.  The reply will be ping_command_reply function. */
+silc_client_command_send(client, conn, SILC_COMMAND_PING,
+                         ping_command_reply, context,
+			 1, 1, server_id, server_id_len);
+
+
    + +

    Notify arguments

    + +In Toolkit 1.1 the following notify arguments have had changes. See +the Notify Arguments for details. You should +go through your application and change the handling of the following notify +messages for Toolkit 1.1. + +
     
    +SILC_NOTIFY_TYPE_NICK_CHANGE
    +SILC_NOTIFY_TYPE_CMODE_CHANGE
    +SILC_NOTIFY_TYPE_SIGNOFF
    +SILC_NOTIFY_TYPE_SERVER_SIGNOFF
    + +
     
    +The basic changes in notify arguments from Toolkit 1.0 is that the +Toolkit 1.1 parses various lists and other raw data for the application as +opposed to sending them in the raw format. This makes programming easier. + +

    Command reply arguments

    + +In Toolkit 1.1 the following command reply arguments have had changes. See +the Command Reply Arguments for +details. You should go through your application and change the handling +of the following command replies for Toolkit 1.1. + +
     
    +SILC_COMMAND_WHOIS
    +SILC_COMMAND_INVITE
    +SILC_COMMAND_STATS
    +SILC_COMMAND_JOIN
    +SILC_COMMAND_CMODE
    +SILC_COMMAND_BAN
    +SILC_COMMAND_DETACH
    +SILC_COMMAND_USERS
    + +
     
    +The basic changes in command reply arguments from Toolkit 1.0 is that the +Toolkit 1.1 parses various lists and other raw data for the application as +opposed to sending them in the raw format.. This makes programming easier. + +

    Other changes in client library

    + +There are many other smaller changes in Toolkit 1.1 that require you to +change your application when porting from Toolkit 1.0. We are not listing +all of them here but briefly mention some API changes. + +
     
    +Listing channel private keys now return SilcDList instead of an array. + +
     
    +The key agreement API has changed a little bit and is now more cleaner and +supports all the features that are needed in full featured key agreement. +The silc_client_peform_key_agreement_fd has been replaced by +silc_client_perform_key_agreement_stream. + +
     
    +The private message key API has slight changes also. It is no longer +necessary for the caller to specify whether the private message key is for +responder or initiator use. + +
     
    +The file transfer API has changed a little bit and is now more cleaner and +supports all the features that are needed in full featured file transfer. +It is now easier to send files when you are behind NAT when you can +specifically define the IPs that are used in both file sending and +receiving. + +
     
    +As a new function silc_client_nickname_format can now be used to format +the nickname of a client entry. The client library automatically formats +the nicknames but in some cases application might like to change the +nickname of a certain client entry. + + +
     
    +

    Utility library, lib/silcutil/

    + +The Utility library (runtime library) has had several changes and has several +new interfaces. Some interfaces has also been removed or moved to some +other library. Removed interfaces rae: silcprotocol.h and silcsockconn.h. +Moved interfaces are: silcapputil.h and +silcvcard.h. + +

    SILC Async Operation Interface

    + +A new asynchronous operation API (silcasync.h) +has been added. It can be used to control asynchronous operations, like +to cancel them. Many asynchronous routines in SILC Toolkit now return +SilcAsyncOperation context so that the operation can be controlled by the +caller. It especiallly provides a generic way to cancel asynchronous +operations which can be difficult. + +

    SILC Atomic Operations Interface

    + +A new atomic operations API (silcatomic.h) +has been added. It provides routines to perform various operations on +integeres and pointers atomically. + +

    SILC Data Stack Interface

    + +A new data stack (memory pool system) API +(silcstack.h) has been added. +It provides a fast memory allocation system. Many routines in the SILC Toolkit +are SilcStack aware thus enabling them to use the SilcStack as their source +for memory allocation. All routines that are SilcStack aware automatically +revert back to normal memory allocation if SilcStack is not given as +argument. See silcstack.h for list of utility routines that support SilcStack +by default. + +

    SILC Condition Variable Interface

    + +A new condition variable API (silccond.h) +has been added. It provides condition variables for multithreaded +applications. + +

    SILC Stream Interface

    + +A new abstract stream API (silcstream.h) +has been added. The SilcStream +provides an abstract way of representing different kinds of streams. The +API provides functions that can be used to read, write, control and destroy +streams. The API is not used to create streams but separate interfaces +exist for streams that use the SilcStream abstraction. For example, +socket stream and file descriptor stream exist. + +

    SILC FD Stream Interface

    + +A new file descriptor stream API +(silcfdstream.h) has been added. It +provides a blocking and non-blocking file descriptor stream through the +SilcStream abstraction. + +

    SILC Socket Stream Interface

    + +A new socket stream API +(silcsocketstream.h) has been added. +It provides a blocking and non-blocking socket stream through the SilcStream +abstraction. + +

    SILC FSM Interface

    + +A new Finite State Machine API +(silcfsm.h) has been added. It provides +an FSM that can be used to implement all kinds of machines and protocols. +The machine also supports threads, and threads that are actually executed +in real system threads. The SILC FSM API also supports asynchronous +events. + +

    SILC Time Interface

    + +A new SILC Time API +(silctime.h) has been added. It provides utility +functions to retrieve and represent time in different ways. It supports +Universal and Generalized time string creation and parsing and adds a new +SilcTime structure to represent time. + +

    SILC Snprintf Interface

    + +A new snprintf API +(silcsnprintf.h) has been added. It +provides snprintf and other string formatting routines. + +

    SILC Mutex Interface changes

    + +The SILC Mutex API (silcmutex.h) +has several changes. A support for read/write locks has been added +(SilcRwLock). Also silc_mutex_assert_locked function is added. + +

    SILC Network Interface changes

    + +The SILC Network API +(silcnet.h) has several changes. The API is almost +entirely rewritten and most of the old functions have been removed. The +API has now both TCP and UDP support, and as previously supports IPv4 +and IPv6. New functions are silc_net_tcp_create_listener, +silc_net_listener_get_port, silc_net_close_listener, silc_net_tcp_connnect, +silc_net_udp_connect, silc_net_udp_receive, silc_net_udp_send. + +

    SILC Scheduler Interface changes

    + +The SILC Schedule API +(silcschedule.h) has several changes. The +scheduler has been entirely rewritten but most of the API remains the same. +The SILC_TASK_GENERIC and SILC_TASK_CALLBACK_GLOCAL have been removed. +The way signal are dispatched has been changed. The SILC Schedule is now +able to itself dispatch all signals. New functions are +silc_schedule_task_add_fd, silc_schedule_task_add_timeout, +silc_schedule_task_add_signal, silc_task_del_by_all, +silc_schedule_get_fd_events. The functions silc_schedule_signal_register, +silc_schedule_signal_unregister and silc_schedule_signal_call have been +removed. + +

    SILC Types Interface changes

    + +The SILC Type API (silctypes.h) has several +changes. The bool type is replaced with SilcBool. Sockets are now +represented by SilcSocket. + +

    SILC String util Interface changes

    + +The SILC string utility API +(silcstrutil.h) has changes. The PEM encoding +and decoding routines has been renamed, silc_base64_encode, +silc_base64_encode_file and silc_base64_decode. The silc_mime_parse has +been removed. A new silc_string_split function has been added. + +

    SILC Utility Interface changes

    + + +

    SILC File Util Interface changes

    + +The SILC file utility API (silcfileutil.h) +has changes. A new function silc_file_set_nonblock has been added. + +

    SILC List and Dynamic List Interface changes

    + +The SILC List (silclist.h) and SILC Dynamic List +(silcdlist.h) APIs have changes. New functions silc_list_insert and +silc_dlist_insert have been added. + +

    SILC Buffer Interface changes

    + +The SILC Buffer API (silcbuffer.h) has several +changes. The SilcBuffer +structure no longer contain the buffer length and true length fields +but silc_buffer_len() and silc_buffr_truelen() macros are available +instead. Also silc_buffer_data(), silc_buffer_datalen(), silc_buffer_purge(), +silc_buffer_reset(), silc_buffer_start(), silc_buffer_end() and +silc_buffer_enlarge() has been added. The API also supports SilcStack. + +

    SILC Buffer Formatting Interface changes

    + +The SILC Buffer Formatting API +(silcbuffmt.h) has several changes. The +silc_buffer_format now automatically allocates memory to the destination +buffer if it does not have space. Also new the following new formatters +have been added: SILC_STR_DATA (replaces SILC_STR_UI_XNSTRING), +SILC_STR_BUFFER, SILC_STR_FUNC, SILC_STF_OFFSET and SILC_STR_ADVANCE. +The API also supports SilcStack. + +

    SILC Memory Interface changes

    + +The memory allocation API (silcmemory.h) has +several changes. It supports now SilcStack as memory source. Also all +memory allocation routines can now fail and return NULL as opposed to fatally +failing when memory allocation fails. + +
     
    +

    SILC Application Utility library, lib/silcapputil/

    + +A new SILC Application Utility library has been added. It provides +various application specific utility libraries that are not part of +the runtime library (lib/silcutil/). The interfaces in the Application +utility library were in other libraries in Toolkit 1.0 and the library +does not contain any entirely new interfaces. + +

    SILC Application Utility Interface

    + +The silcapputil.h contains various application +utility functions. It +existed in Toolkit 1.0 but some of the APIs has been changed. The +silc_create_key_pair, silc_load_key_pair and silc_show_public_key APIs +has changed. A new silc_show_public_key_file has been added. Functions +silc_identifier_check, silc_identifier_verify, silc_channel_name_check, +silc_channel_name_verify, silc_get_mode_list silc_get_status_message, +silc_get_packet_name, silc_get_command_name, silc_parse_version_string, +silc_version_to_num, silc_client_chmode, silc_client_chumode, +silc_client_chumode_char and silc_id_render has been moved from other +libraries into this interface in Toolkit 1.1. + +

    SILC ID Cache Interface

    + +The ID Cache interface (silcidcache.h) has +been moved from lib/silccore into lib/silcapputil/. + +
     
    +

    SILC Key Repository library, lib/silcskr/

    + +A new SILC Key Repository library has been added. The library provides +a SILC Key Repository API (silcskr.h) which provides +a repository for storing and retrieving public keys. + +
     
    +

    SILC VCard library, lib/silcvcard/

    + +A new SILC VCard library has been added. The SILC VCard API has been +moved from utility library to own library in lib/silcvcard/. + +
     
    +

    SILC HTTP library, lib/silchttp/

    + +A new SILC HTTP library has been added. The library includes SILC HTTP +Server Interface and SILC HTTP PHP Translator Interface. + +

    SILC HTTP Server Interface

    + +The SILC HTTP Server API (silchttpservder.h) +provides a simple HTTP server implementation for applications that want to +integrate a small HTTP server. + +

    SILC HTTP PHP Translator Interface

    + +The SILC HTTP PHP Translator API (silchttpphp.h) + provides PHP translates PHP code into HTML. It can be used to serve PHP +pages in HTTP server. + +
     
    +

    SILC ASN.1 library, lib/silcasn1/

    + +A new Abstract Syntax Notation One (ASN.1) library has been added. The +library provides SILC ASN.1 encoder and decoder interface and SILC BER +encoder and decoder interface. + +

    SILC ASN.1 Interface

    + +The SILC ASN.1 API (silcasn1.h) provides ASN.1 +encoder and decoder. The interface provides efficient encoder and decoder +and is support SilcStack as memory source. The interface is simple and it +supports almost all ASN.1 features. + +

    SILC BER Interface

    + +The SILC BER API (silcber.h) provides BER/DER +encoder and decoder. It is integral part of the ASN.1 library and the ASN.1 +encoder and decoder. +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/programming_conv.html b/docs/toolkit/manual/programming_conv.html new file mode 100644 index 0000000..80651e8 --- /dev/null +++ b/docs/toolkit/manual/programming_conv.html @@ -0,0 +1,402 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Programming Conventions + +
     
    +The SILC Toolkit has been programmed with a specific programming style that +is consistent across all libraries and interfaces. The programming style +defines for example naming conventions for functions, structures, macros, +enumerations, and other constants. + + +
     
     
    +Naming Conventions + +
     
    +Macros and Defines + +
     
    +Macros are always capitalised and include underscores to separate words +in the name. All macros start with the "SILC_" prefix. Example: + +
     
    + +#define SILC_PACKET_PADLEN(__packetlen, __blocklen) \
    +  SILC_PACKET_DEFAULT_PADLEN - (__packetlen) % \
    +    ((__blocklen) ? (__blocklen) : SILC_PACKET_DEFAULT_PADLEN) +     + +
     
    +Also other defines (#define) are always capitalised and include +underscores to separate words in the name. Also all defines start with +the "SILC_" prefix. + +
     
    +Structures + +
     
    +All structure names begin with "Silc" prefix, and the name is mixed-case, +for example: SilcClientConnection, SilcCommandPayload. Many of the +structures used in SILC are actually private structures, and application +cannot access them directly. In these cases the structures are forward +declared in the public header, and the implementation of the structure +is in the source file. In these case application does not need to know +the contents of the structure, and is usually provided with a helper API +to access the structure when needed. + +
     
    +In the most of the cases the forward declaration for a structure is pointer, +for example: + +
     
    +typedef struct SilcClientStruct *SilcClient; + +
     
    +Application should always use the type defined pointer instead of the +actual structure. + +
     
    +Functions + +
     
    +Function naming uses the common naming convention used in Toolkit. All +functions are always lowercase and they use underscores. The name of +the function always starts with prefix "silc_". The name tells what +the function do. The name of a function is constructed from following parts: + +
     
    +silc_(module)_(function) + +
     
    +The (module) is the library, or interface this functions is part of. For +example: "cipher", "config", "command", "packet", etc. + +
     
    +The (function) is the description of the functionality of the function. +For example: "read", "new_id", "register", "find_by_name", etc. Examples: + +
     
    + +silc_server_packet_send
    +silc_server_packet_send_to_channel
    +silc_idcache_del_by_id
    +silc_schedule_init
    +silc_protocol_excute_final
    +silc_buffer_alloc +     + +
     
    +When function registers something the name of the function generally is +"silc_function_register" and unregistering is done with +"silc_function_unregister". When function allocates something it +is "silc_function_alloc" and when freeing it is +"silc_function_free". Respectively, with init/uninit functions. + +
     
    +Enumerations + +
     
    +Enumerations are always capitalised and include underscores to separate +words in the name. All enumerations start with the "SILC_" prefix. Also, +usually all enumerations are type defined to a specific name which can +be used as type for the enumeration. Example: + +
     
    + +typedef enum {
    +  SILC_EXAMPLE_ENUM_NONE,
    +  SILC_EXAMPLE_ENUM_LIST,
    +  SILC_EXAMPLE_ENUM_STATUS,
    +} SilcExampleEnum; +     + +
     
    +The naming for the type definition for the enumerations follow the +normal naming convention; the name starts with "Silc" prefix and the +name is mixed-case. + + +
     
     
    +Layout + +
     
    +Indentation + +
     
    +The indendation in the source code is 2 characters, and tabulators are +not used. Example piece of code: + +
     
    + +void silc_client_free(SilcClient client)
    +{
    +  if (client) {
    +    if (client->rng)
    +      silc_rng_free(client->rng);
    +    silc_free(client);
    +  }
    +} +     + +
     
    +Placing Braces + +
     
    +Generally the braces placing the SILC code follows the K&R style; the +opening of the brace is put to the last on the line, and the closing brace +is on first on its own line, except for functions. Examples: + +
     
    + +if (condition) {
    +  silc_something();
    +  silc_something_more();
    +} +     + +
     
    + +int silc_client_function()
    +{
    +  return 0;
    +} +     + +
     
    + +if (condition) {
    +  something;
    +  silc_something_more();
    +} else {
    +  something_else;
    +} +     + +
     
    + +if (condition) {
    +  something;
    +  silc_something_more();
    +} else if (other_condition) {
    +  something;
    +  silc_something_more();
    +} else {
    +  something_else;
    +} +     + +
     
    +Header Files +
     
    + +Standard anti-nesting method is used in the header files to avoid +multiple inclusion of the header file. Example: + +
     
    + +#ifndef SILCHEADER_H
    +#define SILCHEADER_H
    +...
    +#endif /* SILCHEADER_H */ +     + +
     
    +All public header files have the "silc" prefix in the filename, for example: +silcclient.h, silcprivate.h, silcutil.h. There are other header files in +the Toolkit as well. Application should not directly include these headers, +however if needed it may access them. + +
     
    +Every header file also includes a copyright notice. +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_change_private_key_passphrase.html b/docs/toolkit/manual/silcapputil-silc_change_private_key_passphrase.html new file mode 100644 index 0000000..0d43a27 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_change_private_key_passphrase.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_change_private_key_passphrase

    + + +SYNOPSIS + +
    
+    SilcBool silc_change_private_key_passphrase(const char *prv_filename,
+                                                const char *old_passphrase,
+                                                const char *new_passphrase);
+
+
    +DESCRIPTION + +
    
+    This routine can be used to change the passphrase of the private
+    key file, which is used to encrypt the private key.  If the old
+    and new passphrase is not provided for this function this will
+    prompt for them.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_channel_name_check.html b/docs/toolkit/manual/silcapputil-silc_channel_name_check.html new file mode 100644 index 0000000..bc355e8 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_channel_name_check.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_name_check

    + + +SYNOPSIS + +
    
+    unsigned char *
+    silc_channel_name_check(const unsigned char *identifier,
+                            SilcUInt32 identifier_len,
+                            SilcStringEncoding identifier_encoding,
+                            SilcUInt32 max_allowed_length,
+                            SilcUInt32 *out_len);
+
+
    +DESCRIPTION + +
    
+    Checks that the 'identifier' string is valid channel name string
+    and does not contain any unassigned or prohibited character.
+
+    If the 'max_allowed_length' is non-zero the identifier cannot be
+    longer than that, and NULL is returned if it is.  If zero (0), no
+    length limit exist.  For channel names the max length must be 256
+    bytes.
+
+    Returns the validated string, that the caller must free.  Returns
+    NULL if the identifier string is not valid or contain unassigned or
+    prohibited characters.  Such identifier strings must not be used
+    SILC protocol.  The returned string is always in UTF-8 encoding.
+    The length of the returned string is in 'out_len'.
+
+
    +NOTES + +
    
+    In addition of validating the channel name string, this function
+    may map characters to other characters or remove characters from the
+    original string.  This is done as defined in the SILC protocol.  Error
+    is returned only if the string contains unassigned or prohibited
+    characters.  The original 'identifier' is not modified at any point.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_channel_name_verify.html b/docs/toolkit/manual/silcapputil-silc_channel_name_verify.html new file mode 100644 index 0000000..6718552 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_channel_name_verify.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_name_verify

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_channel_name_veirfy(const unsigned char *identifier,
+                             SilcUInt32 identifier_len,
+                             SilcStringEncoding identifier_encoding,
+                             SilcUInt32 max_allowed_length);
+
+
    +DESCRIPTION + +
    
+    Checks that the 'identifier' string is valid channel name string
+    and does not contain any unassigned or prohibited character.
+
+    If the 'max_allowed_length' is non-zero the identifier cannot be
+    longer than that, and NULL is returned if it is.  If zero (0), no
+    length limit exist.  For channel names the max length must be 256
+    bytes.
+
+    Returns TRUE if the string is valid and FALSE if it is prohibited.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_client_chmode.html b/docs/toolkit/manual/silcapputil-silc_client_chmode.html new file mode 100644 index 0000000..5eb9ea3 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_client_chmode.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_chmode

    + + +SYNOPSIS + +
    
+    char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
+                             const char *hmac);
+
+
    +DESCRIPTION + +
    
+    Parses mode mask and returns the mode as string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_client_chumode.html b/docs/toolkit/manual/silcapputil-silc_client_chumode.html new file mode 100644 index 0000000..f77bcbd --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_client_chumode.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_chumode

    + + +SYNOPSIS + +
    
+    char *silc_client_chumode(SilcUInt32 mode);
+
+
    +DESCRIPTION + +
    
+    Parses channel user mode mask and returns te mode as string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_client_chumode_char.html b/docs/toolkit/manual/silcapputil-silc_client_chumode_char.html new file mode 100644 index 0000000..6ab5074 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_client_chumode_char.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_chumode_char

    + + +SYNOPSIS + +
    
+    char *silc_client_chumode_char(SilcUInt32 mode);
+
+
    +DESCRIPTION + +
    
+    Parses channel user mode and returns it as special mode character.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_create_key_pair.html b/docs/toolkit/manual/silcapputil-silc_create_key_pair.html new file mode 100644 index 0000000..384be8b --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_create_key_pair.html @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_create_key_pair

    + + +SYNOPSIS + +
    
+    SilcBool silc_create_key_pair(const char *pkcs_name,
+                                  SilcUInt32 key_len_bits,
+                                  const char *pub_filename,
+                                  const char *prv_filename,
+                                  const char *pub_identifier,
+                                  const char *passphrase,
+                                  SilcPublicKey *return_public_key,
+                                  SilcPrivateKey *return_private_key,
+                                  SilcBool interactive);
+
+
    +DESCRIPTION + +
    
+    This routine can be used to generate new public key and private key
+    pair.  The `pkcs_name' is the name of public key algorithm, or if
+    NULL it defaults to "rsa".  The `key_len_bits' is the key length
+    in bits and if zero (0) it defaults to 4096 bits.  The `pub_filename'
+    and `prv_filename' is the public key and private key filenames.
+    The `pub_identifier' is the public key identifier (for example:
+    "UN=foobar, HN=hostname"), or if NULL the routine generates it
+    automatically.  The `return_public_key' and `return_private_key' may
+    be NULL.
+
+    The `passphrase' is the passphrase that is used to encrypt the
+    private key file.  It is recommended that you would protect your
+    private key file with a passphrase.
+
+    If the `interactive' is TRUE then this asks the user (by blocking
+    the process for input) some questions about key generation (like
+    public key algorithm, key length, filenames, etc).  If all
+    arguments are provided to this function already then `interactive'
+    has no effect.
+
+
    +NOTES + +
    
+    Before calling this function the application must have initialized
+    the crypto library by registering the public key algorithms with
+    silc_pkcs_register_default function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_get_command_name.html b/docs/toolkit/manual/silcapputil-silc_get_command_name.html new file mode 100644 index 0000000..9e64622 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_get_command_name.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_get_command_name

    + + +SYNOPSIS + +
    
+    char *silc_get_command_name(SilcCommand command);
+
+
    +DESCRIPTION + +
    
+    Returns the name corresponding SILC command `command'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_get_mode_list.html b/docs/toolkit/manual/silcapputil-silc_get_mode_list.html new file mode 100644 index 0000000..c32b5eb --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_get_mode_list.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_get_mode_list

    + + +SYNOPSIS + +
    
+    SilcBool silc_get_mode_list(SilcBuffer mode_list,
+                                SilcUInt32 mode_list_count,
+                                SilcUInt32 **list);
+
+
    +DESCRIPTION + +
    
+    Returns modes from list of 32 bit MSB first order values that are
+    encoded one after the other in the `mode_list' into the `list'
+    array.  The caller must free the returned list.  Return FALSE if
+    there is error parsing the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_get_packet_name.html b/docs/toolkit/manual/silcapputil-silc_get_packet_name.html new file mode 100644 index 0000000..8abf768 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_get_packet_name.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_get_packet_name

    + + +SYNOPSIS + +
    
+    char *silc_get_packet_name(SilcPacketType type);
+
+
    +DESCRIPTION + +
    
+    Returns the name corresponding packet type `type'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_get_status_message.html b/docs/toolkit/manual/silcapputil-silc_get_status_message.html new file mode 100644 index 0000000..928f0d8 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_get_status_message.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_get_status_message

    + + +SYNOPSIS + +
    
+    char *silc_get_status_message(SilcStatus status)
+
+
    +DESCRIPTION + +
    
+    Returns status message string
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_id_render.html b/docs/toolkit/manual/silcapputil-silc_id_render.html new file mode 100644 index 0000000..daa5d52 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_id_render.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_render

    + + +SYNOPSIS + +
    
+    char *silc_id_render(void *id, SilcIdType id_type);
+
+
    +DESCRIPTION + +
    
+    Renders ID to suitable to print for example to log file.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_identifier_check.html b/docs/toolkit/manual/silcapputil-silc_identifier_check.html new file mode 100644 index 0000000..bb5c7d5 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_identifier_check.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_identifier_check

    + + +SYNOPSIS + +
    
+    unsigned char *
+    silc_identifier_check(const unsigned char *identifier,
+                          SilcUInt32 identifier_len,
+                          SilcStringEncoding identifier_encoding,
+                          SilcUInt32 max_allowed_length,
+                          SilcUInt32 *out_len);
+
+
    +DESCRIPTION + +
    
+    Checks that the 'identifier' string is valid identifier string
+    and does not contain any unassigned or prohibited character.  This
+    function is used to check for valid nicknames, server names,
+    usernames, hostnames, service names, algorithm names, other security
+    property names, and SILC Public Key name.
+
+    If the 'max_allowed_length' is non-zero the identifier cannot be
+    longer than that, and NULL is returned if it is.  If zero (0), no
+    length limit exist.  For nicknames the max length must be 128 bytes.
+    Other identifiers has no default limit, but application may choose
+    one anyway.
+
+    Returns the validated string, that the caller must free.  Returns
+    NULL if the identifier string is not valid or contain unassigned or
+    prohibited characters.  Such identifier strings must not be used
+    SILC protocol.  The returned string is always in UTF-8 encoding.
+    The length of the returned string is in 'out_len'.
+
+
    +NOTES + +
    
+    In addition of validating the identifier string, this function
+    may map characters to other characters or remove characters from the
+    original string.  This is done as defined in the SILC protocol.  Error
+    is returned only if the string contains unassigned or prohibited
+    characters.  The original 'identifier' is not modified at any point.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_identifier_verify.html b/docs/toolkit/manual/silcapputil-silc_identifier_verify.html new file mode 100644 index 0000000..5bdc03f --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_identifier_verify.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_identifier_verify

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_identifier_check(const unsigned char *identifier,
+                          SilcUInt32 identifier_len,
+                          SilcStringEncoding identifier_encoding,
+                          SilcUInt32 max_allowed_length);
+
+
    +DESCRIPTION + +
    
+    Checks that the 'identifier' string is valid identifier string
+    and does not contain any unassigned or prohibited character.  This
+    function is used to check for valid nicknames, server names,
+    usernames, hostnames, service names, algorithm names, other security
+    property names, and SILC Public Key name.
+
+    If the 'max_allowed_length' is non-zero the identifier cannot be
+    longer than that, and NULL is returned if it is.  If zero (0), no
+    length limit exist.  For nicknames the max length must be 128 bytes.
+    Other identifiers has no default limit, but application may choose
+    one anyway.
+
+    Returns TRUE if the string is valid and FALSE if it is prohibited.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_load_key_pair.html b/docs/toolkit/manual/silcapputil-silc_load_key_pair.html new file mode 100644 index 0000000..2151d95 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_load_key_pair.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_load_key_pair

    + + +SYNOPSIS + +
    
+    SilcBool silc_load_key_pair(const char *pub_filename,
+                                const char *prv_filename,
+                                const char *passphrase,
+                                SilcPublicKey *return_public_key,
+                                SilcPrivateKey *return_private_key);
+
+
    +DESCRIPTION + +
    
+    This routine can be used to load the public key and private key
+    from files.  This retuns FALSE it either of the key could not be
+    loaded.  This function returns TRUE on success and returns the
+    public key into `return_public_key' pointer and private key into
+    `return_private_key'.  The `passphrase' is the passphrase which
+    will be used to decrypt the private key file.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_parse_version_string.html b/docs/toolkit/manual/silcapputil-silc_parse_version_string.html new file mode 100644 index 0000000..024c36c --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_parse_version_string.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_parse_version_string

    + + +SYNOPSIS + +
    
+    SilcBool silc_parse_version_string(const char *version,
+                                       SilcUInt32 *protocol_version,
+                                       char **protocol_version_string,
+                                       SilcUInt32 *software_version,
+                                       char **software_version_string,
+                                       char **vendor_version);
+
+
    +DESCRIPTION + +
    
+    Parses SILC protocol style version string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_show_public_key.html b/docs/toolkit/manual/silcapputil-silc_show_public_key.html new file mode 100644 index 0000000..fa0b769 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_show_public_key.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_show_public_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_show_public_key(SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    This routine can be used to dump the SILC public key into human
+    readable form into stdout.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_show_public_key_file.html b/docs/toolkit/manual/silcapputil-silc_show_public_key_file.html new file mode 100644 index 0000000..13bd403 --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_show_public_key_file.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_show_public_key_file

    + + +SYNOPSIS + +
    
+    SilcBool silc_show_public_key_file(const char *pub_filename);
+
+
    +DESCRIPTION + +
    
+    This routine can be used to dump the contents of the public key
+    in the public key file `pub_filename'.  This dumps the public key
+    into human readable form into stdout.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil-silc_version_to_num.html b/docs/toolkit/manual/silcapputil-silc_version_to_num.html new file mode 100644 index 0000000..c75838e --- /dev/null +++ b/docs/toolkit/manual/silcapputil-silc_version_to_num.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_version_to_num

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_version_to_num(const char *version);
+
+
    +DESCRIPTION + +
    
+    Converts version string x.x into number representation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Application Utilities
    +silc_create_key_pair
    +silc_load_key_pair
    +silc_show_public_key
    +silc_show_public_key_file
    +silc_change_private_key_passphrase
    +silc_identifier_check
    +silc_identifier_verify
    +silc_channel_name_check
    +silc_channel_name_verify
    +silc_get_mode_list
    +silc_get_status_message
    +silc_get_packet_name
    +silc_get_command_name
    +silc_parse_version_string
    +silc_version_to_num
    +silc_client_chmode
    +silc_client_chumode
    +silc_client_chumode_char
    +silc_id_render
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil.html b/docs/toolkit/manual/silcapputil.html new file mode 100644 index 0000000..f4d0a1a --- /dev/null +++ b/docs/toolkit/manual/silcapputil.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcapputil.html + + + + +
    + +SILC Application Utilities
    Header: silcapputil.h

    + + +DESCRIPTION + +
    
+ This interface provides utility functions for applications'
+ convenience.  It provides functions that may be used for example by
+ command line applications but also other applications may find some
+ routines helpful.  None of these routines are mandatory in any other
+ SILC routines or libraries, and are purely provided for convenience.
+ These routines for example provide simple public key and private key
+ pair generation, public key and private key file saving and loading
+ for application, and other similar routines.
+
+
  • silc_create_key_pair +
  • silc_load_key_pair +
  • silc_show_public_key +
  • silc_show_public_key_file +
  • silc_change_private_key_passphrase +
  • silc_identifier_check +
  • silc_identifier_verify +
  • silc_channel_name_check +
  • silc_channel_name_verify +
  • silc_get_mode_list +
  • silc_get_status_message +
  • silc_get_packet_name +
  • silc_get_command_name +
  • silc_parse_version_string +
  • silc_version_to_num +
  • silc_client_chmode +
  • silc_client_chumode +
  • silc_client_chumode_char +
  • silc_id_render + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcapputil.xref b/docs/toolkit/manual/silcapputil.xref new file mode 100644 index 0000000..563c8c3 --- /dev/null +++ b/docs/toolkit/manual/silcapputil.xref @@ -0,0 +1,26 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcapputil.h" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 0 + "SILC Application Utilities" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 1 + "silc_create_key_pair" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_load_key_pair" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_show_public_key" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_show_public_key_file" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_change_private_key_passphrase" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_identifier_check" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_identifier_verify" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_channel_name_check" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_channel_name_verify" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_get_mode_list" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_get_status_message" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_get_packet_name" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_get_command_name" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_parse_version_string" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_version_to_num" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_client_chmode" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_client_chumode" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_client_chumode_char" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + "silc_id_render" "/home/priikone/silc1/doc/toolkit/silcapputil.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcaputillib.html b/docs/toolkit/manual/silcaputillib.html new file mode 100644 index 0000000..e7e17e6 --- /dev/null +++ b/docs/toolkit/manual/silcaputillib.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Application Utility Library +
    +Directory: lib/silcapputil/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Application Utility library provides various SILC application +specific utility functions. For example, it provides routines for +creating and loading SILC key pair. + +

    + +
  • SILC Application Utilities +
  • SILC ID Cache Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-SilcArgumentDecodeType.html b/docs/toolkit/manual/silcargument-SilcArgumentDecodeType.html new file mode 100644 index 0000000..88cec26 --- /dev/null +++ b/docs/toolkit/manual/silcargument-SilcArgumentDecodeType.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcArgumentDecodeType

    + + +NAME + +
    
+    typedef enum { ... } SilcArgumentDecodeType;
+
+
    +DESCRIPTION + +
    
+    Argument decode types used with silc_argument_get_decoded.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_ARGUMENT_ID,             /* SilcID */
+      SILC_ARGUMENT_PUBLIC_KEY,     /* SilcPublicKey (always alloc) */
+      SILC_ARGUMENT_ATTRIBUTES,     /* SilcDList (always alloc) */
+      SILC_ARGUMENT_UINT32,         /* SilcUInt32 */
+      SILC_ARGUMENT_BOOL,           /* SilcBool */
+    } SilcArgumentDecodeType;
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-SilcArgumentDecodedList.html b/docs/toolkit/manual/silcargument-SilcArgumentDecodedList.html new file mode 100644 index 0000000..0c50f54 --- /dev/null +++ b/docs/toolkit/manual/silcargument-SilcArgumentDecodedList.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcArgumentDecodedList

    + + +NAME + +
    
+    typedef struct { ... } *SilcArgumentDecodedList;
+
+
    +DESCRIPTION + +
    
+    This structure is in the list returned by the function
+    silc_argument_list_payload_parse_decoded.  The caller is responsible
+    of freeing the contents of the structure and the structure itself.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-SilcArgumentPayload.html b/docs/toolkit/manual/silcargument-SilcArgumentPayload.html new file mode 100644 index 0000000..3f1e4ac --- /dev/null +++ b/docs/toolkit/manual/silcargument-SilcArgumentPayload.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcArgumentPayload

    + + +NAME + +
    
+    typedef struct SilcArgumentPayloadStruct *SilcArgumentPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Argument Payload and is allocated
+    by silc_argument_payload_parse and given as argument usually to
+    all silc_argument_payload_* functions.  It is freed by the
+    silc_argument_payload_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_get_arg_num.html b/docs/toolkit/manual/silcargument-silc_argument_get_arg_num.html new file mode 100644 index 0000000..93f3eb5 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_get_arg_num.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_get_arg_num

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_argument_get_arg_num(SilcArgumentPayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the number of arguments in the Argument Payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_get_arg_type.html b/docs/toolkit/manual/silcargument-silc_argument_get_arg_type.html new file mode 100644 index 0000000..11617ee --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_get_arg_type.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_get_arg_type

    + + +SYNOPSIS + +
    
+    unsigned char *silc_argument_get_arg_type(SilcArgumentPayload payload,
+                                              SilcUInt32 type,
+                                              SilcUInt32 *ret_len);
+
+
    +DESCRIPTION + +
    
+    Returns argument by type. The returned argument has type `type'
+    in the Argument Payload. Each argument has their own type (or zero
+    if no specific type is set). The length of the argument is returned
+    to the `ret_len'. The caller must not free the returned argument.
+    Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_get_decoded.html b/docs/toolkit/manual/silcargument-silc_argument_get_decoded.html new file mode 100644 index 0000000..488c182 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_get_decoded.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_get_decoded

    + + +SYNOPSIS + +
    
+    SilcBool silc_argument_get_decoded(SilcArgumentPayload payload,
+                                       SilcUInt32 type,
+                                       SilcArgumentDecodeType dec_type,
+                                       void *ret_arg,
+                                       void *ret_arg_alloc);
+
+
    +DESCRIPTION + +
    
+    Returns decoded argument by type.  This is a helper function to
+    decode common argument types directly.  The `type' is the argument
+    type number in the payload, and the `dec_type' is the type the
+    argument is decoded to.  If the `ret_arg' is non-NULL then the
+    decodec data is returned into that pointer.  If the `ret_arg_alloc'
+    is non-NULL then this function will allocate the decoded data and
+    will return the pointer into `ret_arg_alloc'.  Some types must always
+    be allocated; see SilcArgumentDecodeType.
+
+    Return TRUE if the argument was present and waa successfully decoded.
+    FALSE if it is not present, or could not be decoded.
+
+
    +EXAMPLE + +
    
+    SilcID id;
+    SilcPublicKey public_key;
+
+    if (!silc_argument_get_decoded(args, 2, SILC_ARGUMENT_ID, &id, NULL))
+      error;
+
+    if (!silc_argument_get_decoded(args, 4, SILC_ARGUMENT_PUBLIC_KEY,
+                                   NULL, &public_key))
+      error;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_get_first_arg.html b/docs/toolkit/manual/silcargument-silc_argument_get_first_arg.html new file mode 100644 index 0000000..af1f595 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_get_first_arg.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_get_first_arg

    + + +SYNOPSIS + +
    
+    unsigned char *silc_argument_get_first_arg(SilcArgumentPayload payload,
+                                               SilcUInt32 *type,
+                                               SilcUInt32 *ret_len);
+
+
    +DESCRIPTION + +
    
+    Returns the first argument in the Argument Payload. The lenght
+    of the argument is returned to `ret_len'. The caller must not
+    free the returned argument. Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_get_next_arg.html b/docs/toolkit/manual/silcargument-silc_argument_get_next_arg.html new file mode 100644 index 0000000..bb3836e --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_get_next_arg.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_get_next_arg

    + + +SYNOPSIS + +
    
+    unsigned char *silc_argument_get_next_arg(SilcArgumentPayload payload,
+                                              SilcUInt32 *ret_len);
+
+
    +DESCRIPTION + +
    
+    Returns next argument from the Argument Payload. The length of
+    the argument is returned to `ret_len'. The caller must not free
+    the returned argument. This returns NULL when there are no more
+    arguments in the payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_list_free.html b/docs/toolkit/manual/silcargument-silc_argument_list_free.html new file mode 100644 index 0000000..2759d47 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_list_free.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_list_free

    + + +SYNOPSIS + +
    
+    void
+    silc_argument_list_free(SilcDList list, SilcArgumentDecodeType dec_type);
+
+
    +DESCRIPTION + +
    
+    Free's the decoded argument list and its contents.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_list_parse.html b/docs/toolkit/manual/silcargument-silc_argument_list_parse.html new file mode 100644 index 0000000..68d31f6 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_list_parse.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_list_parse

    + + +SYNOPSIS + +
    
+    SilcArgumentPayload
+    silc_argument_list_parse(const unsigned char *payload,
+                             SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parses argument list payload.  Returns parsed SilcArgumentPayload which
+    contains all the arguments from the list.  The caller must free the
+    returned context with silc_argument_payload_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_list_parse_decoded.html b/docs/toolkit/manual/silcargument-silc_argument_list_parse_decoded.html new file mode 100644 index 0000000..8e473af --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_list_parse_decoded.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_list_parse_decoded

    + + +SYNOPSIS + +
    
+    SilcDList
+    silc_argument_list_parse_decoded(const unsigned char *payload,
+                                     SilcUInt32 payload_len,
+                                     SilcArgumentDecodeType dec_type);
+
+
    +DESCRIPTION + +
    
+    Parses argument list payload of arguments of the type `dec_type'.
+    The returned list includes the already decoded arguments.  The caller
+    is responsible of freeing the the contents of the list and the list
+    itself.  Each entry in the list is SilcArgumentDecodedList.  The
+    caller must free the returned list with silc_argument_list_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_payload_encode.html b/docs/toolkit/manual/silcargument-silc_argument_payload_encode.html new file mode 100644 index 0000000..a92219a --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_payload_encode.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_argument_payload_encode(SilcUInt32 argc,
+                                            unsigned char **argv,
+                                            SilcUInt32 *argv_lens,
+                                            SilcUInt32 *argv_types);
+
+
    +DESCRIPTION + +
    
+    Encodes arguments in to Argument Paylods returning them to SilcBuffer.
+    The `argv' is the array of the arguments, the `argv_lens' array of
+    the length of the `argv' arguments and the `argv_types' array of
+    the argument types of the `argv' arguments. The `argc' is the
+    number of arguments.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_payload_encode_one.html b/docs/toolkit/manual/silcargument-silc_argument_payload_encode_one.html new file mode 100644 index 0000000..b43f595 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_payload_encode_one.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_payload_encode_one

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_argument_payload_encode_one(SilcBuffer args,
+                                                unsigned char *arg,
+                                                SilcUInt32 arg_len,
+                                                SilcUInt32 arg_type);
+
+
    +DESCRIPTION + +
    
+    Same as silc_argument_payload_encode but encodes one argument to
+    the buffer `args' and returns the buffer.  The returned buffer
+    may be different than the `args'.  If `args' is NULL for the first
+    argument this allocates the buffer and returns it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_payload_encode_payload.html b/docs/toolkit/manual/silcargument-silc_argument_payload_encode_payload.html new file mode 100644 index 0000000..c6ce99d --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_payload_encode_payload.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_payload_encode_payload

    + + +SYNOPSIS + +
    
+    SilcBuffer
+    silc_argument_payload_encode_payload(SilcArgumentPayload payload);
+
+
    +DESCRIPTION + +
    
+    Same as silc_argument_payload_encode but encodes the payload from
+    already allocated SilcArgumentPayload structure instead of raw data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_payload_free.html b/docs/toolkit/manual/silcargument-silc_argument_payload_free.html new file mode 100644 index 0000000..6991f74 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_payload_free.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_payload_free

    + + +SYNOPSIS + +
    
+    void silc_argument_payload_free(SilcArgumentPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Argument Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument-silc_argument_payload_parse.html b/docs/toolkit/manual/silcargument-silc_argument_payload_parse.html new file mode 100644 index 0000000..20b3054 --- /dev/null +++ b/docs/toolkit/manual/silcargument-silc_argument_payload_parse.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_argument_payload_parse

    + + +SYNOPSIS + +
    
+    SilcArgumentPayload
+    silc_argument_payload_parse(const unsigned char *payload,
+                                SilcUInt32 payload_len,
+                                SilcUInt32 argc);
+
+
    +DESCRIPTION + +
    
+    Parses arguments and returns them into Argument Payload structure.
+    the `buffer' is raw Argument Payload data buffer. The `argc' is
+    the number of arguments in the Argument Payload. The caller must
+    know the number of the arguments. This is always known as the
+    Argument payload is associated with other payloads which defines
+    the number of the arguments.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Argument Interface
    +SilcArgumentPayload
    +silc_argument_payload_parse
    +silc_argument_payload_encode
    +silc_argument_payload_encode_one
    +silc_argument_payload_encode_payload
    +silc_argument_payload_free
    +silc_argument_get_arg_num
    +silc_argument_get_first_arg
    +silc_argument_get_next_arg
    +silc_argument_get_arg_type
    +SilcArgumentDecodeType
    +silc_argument_get_decoded
    +silc_argument_list_parse
    +SilcArgumentDecodedList
    +silc_argument_list_parse_decoded
    +silc_argument_list_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument.html b/docs/toolkit/manual/silcargument.html new file mode 100644 index 0000000..3047d10 --- /dev/null +++ b/docs/toolkit/manual/silcargument.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcargument.html + + + + +
    + +SILC Argument Interface
    Header: silcargument.h

    + + +DESCRIPTION + +
    
+ Implementations of the Argument Payload and Argument List Payload, that
+ is used to include arguments to other payload that needs arguments.
+
+
  • SilcArgumentPayload +
  • silc_argument_payload_parse +
  • silc_argument_payload_encode +
  • silc_argument_payload_encode_one +
  • silc_argument_payload_encode_payload +
  • silc_argument_payload_free +
  • silc_argument_get_arg_num +
  • silc_argument_get_first_arg +
  • silc_argument_get_next_arg +
  • silc_argument_get_arg_type +
  • SilcArgumentDecodeType +
  • silc_argument_get_decoded +
  • silc_argument_list_parse +
  • SilcArgumentDecodedList +
  • silc_argument_list_parse_decoded +
  • silc_argument_list_free + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcargument.xref b/docs/toolkit/manual/silcargument.xref new file mode 100644 index 0000000..8cf35ca --- /dev/null +++ b/docs/toolkit/manual/silcargument.xref @@ -0,0 +1,23 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcargument.h" "/home/priikone/silc1/doc/toolkit/silcargument.html" 0 + "SILC Argument Interface" "/home/priikone/silc1/doc/toolkit/silcargument.html" 1 + "SilcArgumentPayload" "/home/priikone/silc1/doc/toolkit/silcargument.html" 5 + "silc_argument_payload_parse" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_payload_encode" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_payload_encode_one" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_payload_encode_payload" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_payload_free" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_get_arg_num" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_get_first_arg" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_get_next_arg" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_get_arg_type" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "SilcArgumentDecodeType" "/home/priikone/silc1/doc/toolkit/silcargument.html" 8 + "silc_argument_get_decoded" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_list_parse" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "SilcArgumentDecodedList" "/home/priikone/silc1/doc/toolkit/silcargument.html" 5 + "silc_argument_list_parse_decoded" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + "silc_argument_list_free" "/home/priikone/silc1/doc/toolkit/silcargument.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_ANY.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_ANY.html new file mode 100644 index 0000000..3915ade --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_ANY.html @@ -0,0 +1,278 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_ANY

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_ANY(buffer)
+    SILC_ASN1_ANY_T(opts, tag, buffer)
+
+    Decoding:
+    SILC_ASN1_ANY(&buffer)
+    SILC_ASN1_ANY_T(opts, tag, buffer)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode another ASN.1 node.  The buffer type
+    is SilcBuffer.  This macro can be used for example to split large
+    tree into multiple nodes, and then decoding the nodes separately from
+    the buffers.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +EXAMPLE + +
    
+    // Encode node of two boolean values
+    silc_asn1_encode(asn1, node,
+                     SILC_ASN1_BOOLEAN(val1),
+                     SILC_ASN1_BOOLEAN(val2),
+                     SILC_ASN1_END);
+
+    // Encode tree with the node
+    silc_asn1_encode(asn1, tree,
+                     SILC_ASN1_SEQUENCE_T(SILC_ASN1_PRIVATE, 101),
+                       SILC_ASN1_ANY(node),
+                       SILC_ASN1_BOOLEAN(boolval),
+                     SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_ANY_PRIMITIVE.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_ANY_PRIMITIVE.html new file mode 100644 index 0000000..c4df7ad --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_ANY_PRIMITIVE.html @@ -0,0 +1,284 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_ANY_PRIMITIVE

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_ANY_PRIMITIVE(tag, buffer)
+    SILC_ASN1_ANY_PRIMITIVE_T(opts, tag, buffer)
+
+    Decoding:
+    SILC_ASN1_ANY_PRIMITIVE(tag, &buffer)
+    SILC_ASN1_ANY_PRIMITIVE_T(opts, tag, buffer)
+
+
    +DESCRIPTION + +
    
+    Special macro used to encode pre-encoded primitive data blob.  The data
+    can be any primitive type that is already encoded in correct format.
+    The caller is responsible of making sure the data is formatted
+    correctly.  When decoding this returns the raw data blob and the caller
+    must know of what type and format it is.  The buffer type is SilcBuffer.
+
+    This macro can be used in cases when the data to be encoded is already
+    in encoded format, and it only needs to be added to ASN.1 tree.  The
+    SILC_ASN1_ANY cannot be used with primitives when tagging implicitly,
+    in these cases this macro can be used.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +EXAMPLE + +
    
+    // Get MP integer in encoded format
+    mpbuf = mp_get_octet_string(mp);
+
+    // Encode the MP integer data to the tree
+    silc_asn1_encode(asn1, tree,
+                     SILC_ASN1_ANY_PRIMITIVE(SILC_ASN1_TAG_INTEGER, mpbuf),
+                     SILC_ASN1_END);
+
+    // Decode the MP integer data from the tree
+    silc_asn1_decode(asn1, tree,
+                     SILC_ASN1_ANY_PRIMITIVE(SILC_ASN1_TAG_INTEGER, &buffer),
+                     SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_BIT_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_BIT_STRING.html new file mode 100644 index 0000000..95f58fc --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_BIT_STRING.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_BIT_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_BIT_STRING(str, str_len)
+    SILC_ASN1_BIT_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_BIT_STRING(&str, &str_len)
+    SILC_ASN1_BIT_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode bit string.  The string length in
+    encoding must be in bits (bytes * 8).  The decoded length is in
+    bits as well.  The string type is unsigned char and string length
+    SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_BMP_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_BMP_STRING.html new file mode 100644 index 0000000..e548764 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_BMP_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_BMP_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_BMP_STRING(str, str_len)
+    SILC_ASN1_BMP_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_BMP_STRING(&str, &str_len)
+    SILC_ASN1_BMP_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode BMP (UCS-2) string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from BMP (UCS-2)
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_BOOLEAN.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_BOOLEAN.html new file mode 100644 index 0000000..7bccdfb --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_BOOLEAN.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_BOOLEAN

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_BOOLEAN(boolval)
+    SILC_ASN1_BOOLEAN_T(opts, tag, boolval)
+
+    Decoding:
+    SILC_ASN1_BOOLEAN(&boolval)
+    SILC_ASN1_BOOLEAN_T(opts, tag, &boolval)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode boolean value.  The boolean type
+    is SilcBool.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_CHOICE.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_CHOICE.html new file mode 100644 index 0000000..bd7ccc0 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_CHOICE.html @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_CHOICE

    + + +SYNOPSIS + +
    
+    Decoding:
+    SILC_ASN1_CHOICE
+
+
    +DESCRIPTION + +
    
+    Macro used to specify choices in decoding.  The choice list must
+    be terminated with SILC_ASN1_END.  There is no limit how many choices
+    can be specified in the list.
+
+
    +EXAMPLE + +
    
+    // Decode timeval that is either UTC or generalized time
+    silc_asn1_decode(asn1, tree,
+                     SILC_ASN1_SEQUENCE,
+                       SILC_ASN1_CHOICE,
+                         SILC_ASN1_UTC_TIME(&timeval),
+                         SILC_ASN1_GEN_TIME(&timeval),
+                       SILC_ASN1_END,
+                     SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_END.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_END.html new file mode 100644 index 0000000..61df047 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_END.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_END

    + + +SYNOPSIS + +
    
+    SILC_ASN1_END
+
+
    +DESCRIPTION + +
    
+    The SILC_ASN1_END is used to terminate the variable argument list in
+    silc_asn1_encode and silc_asn1_decode functions.  It is also used to
+    terminate SILC_ASN1_SEQUENCE, SILC_ASN1_SEQUENCE_T, SILC_ASN1_SET,
+    SILC_ASN1_SET_T, SILC_ASN1_SEQUENCE_OF, SILC_ASN1_SET_OF and
+    SILC_ASN1_CHOICE macros.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_ENUM.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_ENUM.html new file mode 100644 index 0000000..4e7b969 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_ENUM.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_ENUM

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_ENUM(enum)
+    SILC_ASN1_ENUM_T(opts, tag, &enum)
+
+    Decoding:
+    SILC_ASN1_ENUM(&enum)
+    SILC_ASN1_ENUM_T(opts, tag, &enum);
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode enumeration value.  The enumeration
+    type is SilcMPInt.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_GENERAL_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_GENERAL_STRING.html new file mode 100644 index 0000000..42398a9 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_GENERAL_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_GENERAL_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_GENERAL_STRING(str, str_len)
+    SILC_ASN1_GENERAL_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_GENERAL_STRING(&str, &str_len)
+    SILC_ASN1_GENERAL_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode general string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from general.  NOTE: this implementation use 8-bit ASCII.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_GEN_TIME.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_GEN_TIME.html new file mode 100644 index 0000000..07ece9d --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_GEN_TIME.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_GEN_TIME

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_GEN_TIME(timeval)
+    SILC_ASN1_GEN_TIME_T(opts, tag, timeval)
+
+    Decoding:
+    SILC_ASN1_GEN_TIME(&str, &timeval)
+    SILC_ASN1_GEN_TIME_T(opts, tag, timeval)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode generalized time value.  The
+    time value type is SilcTime.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_IA5_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_IA5_STRING.html new file mode 100644 index 0000000..a18bbf3 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_IA5_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_IA5_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_IA5_STRING(str, str_len)
+    SILC_ASN1_IA5_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_IA5_STRING(&str, &str_len)
+    SILC_ASN1_IA5_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode US ASCII (IA5) string.  The string type
+    is unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from US ASCII (IA5).
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_INT.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_INT.html new file mode 100644 index 0000000..2496fa7 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_INT.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_INT

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_INT(integer)
+    SILC_ASN1_INT_T(opts, tag, &integer)
+
+    Decoding:
+    SILC_ASN1_INT(&integer)
+    SILC_ASN1_INT_T(opts, tag, &integer);
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode multiple precision integer.  The
+    integer type is SilcMPInt.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_NULL.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_NULL.html new file mode 100644 index 0000000..db87ef2 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_NULL.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_NULL

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_NULL
+    SILC_ASN1_NULL_T(opts, tag)
+
+    Decoding:
+    SILC_ASN1_NULL
+    SILC_ASN1_NULL_T(opts, tag)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode null value.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_NUMERIC_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_NUMERIC_STRING.html new file mode 100644 index 0000000..cce8258 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_NUMERIC_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_NUMERIC_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_NUMERIC_STRING(str, str_len)
+    SILC_ASN1_NUMERIC_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_NUMERIC_STRING(&str, &str_len)
+    SILC_ASN1_NUMERIC_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode numerical string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from numerical.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_OCTET_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_OCTET_STRING.html new file mode 100644 index 0000000..270d135 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_OCTET_STRING.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_OCTET_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_OCTET_STRING(str, str_len)
+    SILC_ASN1_OCTET_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_OCTET_STRING(&str, &str_len)
+    SILC_ASN1_OCTET_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode octet string.  The string type is
+    unsigned char and string length SilcUInt32.  Octet string is
+    considered to be 8-bit unsigned binary data.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_OID.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_OID.html new file mode 100644 index 0000000..9f5e398 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_OID.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_OID

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_OID(oid)
+    SILC_ASN1_OID_T(opts, tag, oid)
+
+    Decoding:
+    SILC_ASN1_OID(&oid)
+    SILC_ASN1_OID_T(opts, tag, &oid)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode OID string.  The OID string type
+    is NULL terminated char.  Its length can be determinted with strlen().
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_OPTS.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_OPTS.html new file mode 100644 index 0000000..9570708 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_OPTS.html @@ -0,0 +1,272 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_OPTS

    + + +SYNOPSIS + +
    
+    SILC_ASN1_OPTS(opts)
+
+
    +DESCRIPTION + +
    
+    The `opts' is SilcAsn1Options.  This macro can be used to set
+    options for silc_asn1_encode and silc_asn1_decode functions.
+
+
    +NOTES + +
    
+    Only the SILC_ASN1_ALLOC and SILC_ASN1_ACCUMUL flags may be
+    set with this macro.
+
+    This macro must be the first macro in the variable argument list
+    in the function.
+
+
    +EXAMPLE + +
    
+    silc_asn1_decode(asn1, tree,
+                     SILC_ASN1_OPTS(SILC_ASN1_ALLOC),
+                     SILC_ASN1_SEQUENCE,
+                       SILC_ASN1_BOOLEAN(&bool_val),
+                       SILC_ASN1_OCTET_STRING(&string, &string_len),
+                     SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_PRINTABLE_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_PRINTABLE_STRING.html new file mode 100644 index 0000000..c684605 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_PRINTABLE_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_PRINTABLE_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_PRINTABLE_STRING(str, str_len)
+    SILC_ASN1_PRINTABLE_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_PRINTABLE_STRING(&str, &str_len)
+    SILC_ASN1_PRINTABLE_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode printable string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from printable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE.html new file mode 100644 index 0000000..34affea --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_SEQUENCE

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_SEQUENCE
+    SILC_ASN1_SEQUENCE_T(opts, tag)
+
+    Decoding:
+    SILC_ASN1_SEQUENCE
+    SILC_ASN1_SEQUENCE_T(opts, tag)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode sequence.  The sequence must be
+    terminated with SILC_ASN1_END.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +EXAMPLE + +
    
+    silc_asn1_encode(asn1, tree,
+                     SILC_ASN1_SEQUENCE,
+                       SILC_ASN1_ANY(node),
+                       SILC_ASN1_BOOLEAN(boolval),
+                     SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE_OF.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE_OF.html new file mode 100644 index 0000000..bc1cd9e --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_SEQUENCE_OF.html @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_SEQUENCE_OF

    + + +SYNOPSIS + +
    
+    Decoding:
+    SILC_ASN1_SEQUENCE_OF(bufarray, numbufs)
+
+
    +DESCRIPTION + +
    
+    Macro used to decode sequence of specified type.  This returns
+    an array of SilcBuffers and number of buffers in the array.  The
+    SILC_ASN1_CHOICE macro may also be used with this macro.
+
+
    +NOTES + +
    
+    This macro must be used either with SILC_ASN1_ALLOC or SILC_ASN1_ACCUMUL
+    flags.  Do not use this macro without flags.
+
+
    +EXAMPLE + +
    
+     SilcBuffer bufs;
+     SilcUInt32 count;
+
+     // Decode sequence of sequences.  Each returned buffer in the array
+     // is a sequence.
+     silc_asn1_decode(asn1, exts,
+                      SILC_ASN1_OPTS(SILC_ASN1_ACCUMUL),
+                      SILC_ASN1_SEQUENCE_OF(&bufs, &count),
+                        SILC_ASN1_TAG_SEQUENCE,
+                      SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_SET.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_SET.html new file mode 100644 index 0000000..893c011 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_SET.html @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_SET

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_SET
+    SILC_ASN1_SET_T(opts, tag)
+
+    Decoding:
+    SILC_ASN1_SET
+    SILC_ASN1_SET_T(opts, tag)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode set.  The set must be terminated
+    with SILC_ASN1_END.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +EXAMPLE + +
    
+    silc_asn1_encode(asn1, tree,
+                     SILC_ASN1_SET_T(SILC_ASN1_EXPLICIT, 0),
+                       SILC_ASN1_BOOLEAN(boolval),
+                     SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_SET_OF.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_SET_OF.html new file mode 100644 index 0000000..b4fad0c --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_SET_OF.html @@ -0,0 +1,272 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_SET_OF

    + + +SYNOPSIS + +
    
+    Decoding:
+    SILC_ASN1_SET_OF(bufarray, numbufs)
+
+
    +DESCRIPTION + +
    
+    Macro used to decode set of specified type.  This returns
+    an array of SilcBuffers and number of buffers in the array.  The
+    SILC_ASN1_CHOICE macro may also be used with this macro.
+
+
    +NOTES + +
    
+    This macro must be used either with SILC_ASN1_ALLOC or SILC_ASN1_ACCUMUL
+    flags.  Do not use this macro without flags.
+
+
    +EXAMPLE + +
    
+     // Decode set of sequences.  Each returned buffer in the array
+     // is a sequence.
+     silc_asn1_decode(asn1, exts,
+                      SILC_ASN1_OPTS(SILC_ASN1_ALLOC),
+                      SILC_ASN1_SET_OF(&bufs, &count),
+                        SILC_ASN1_TAG_SEQUENCE,
+                      SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_SHORT_INT.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_SHORT_INT.html new file mode 100644 index 0000000..1a27fe0 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_SHORT_INT.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_SHORT_INT

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_SHORT_INT(integer)
+    SILC_ASN1_SHORT_INT_T(opts, tag, &integer)
+
+    Decoding:
+    SILC_ASN1_SHORT_INT(&integer)
+    SILC_ASN1_SHORT_INT_T(opts, tag, &integer);
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode short integer (32 bits).  The
+    integer type is SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_TELETEX_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_TELETEX_STRING.html new file mode 100644 index 0000000..f61818d --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_TELETEX_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_TELETEX_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_TELETEX_STRING(str, str_len)
+    SILC_ASN1_TELETEX_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_TELETEX_STRING(&str, &str_len)
+    SILC_ASN1_TELETEX_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode teletex (T61) string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from teletex (T61).
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_UNIVERSAL_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_UNIVERSAL_STRING.html new file mode 100644 index 0000000..4bc7b1f --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_UNIVERSAL_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_UNIVERSAL_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_UNIVERSAL_STRING(str, str_len)
+    SILC_ASN1_UNIVERSAL_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_UNIVERSAL_STRING(&str, &str_len)
+    SILC_ASN1_UNIVERSAL_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode universal (UCS-4) string.  The string
+    type is unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from universal (UCS-4).
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_UNRESTRICTED_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_UNRESTRICTED_STRING.html new file mode 100644 index 0000000..86d491b --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_UNRESTRICTED_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_UNRESTRICTED_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_UNRESTRICTED_STRING(str, str_len)
+    SILC_ASN1_UNRESTRICTED_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_UNRESTRICTED_STRING(&str, &str_len)
+    SILC_ASN1_UNRESTRICTED_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode unrestricted string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from unrestricted.  NOTE: this implementation use 8-bit ASCII.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_UTC_TIME.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_UTC_TIME.html new file mode 100644 index 0000000..851147d --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_UTC_TIME.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_UTC_TIME

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_UTC_TIME(timeval)
+    SILC_ASN1_UTC_TIME_T(opts, tag, timeval)
+
+    Decoding:
+    SILC_ASN1_UTC_TIME(&str, &timeval)
+    SILC_ASN1_UTC_TIME_T(opts, tag, timeval)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode universal (UTC) time value.  The
+    time value type is SilcTime.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_UTF8_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_UTF8_STRING.html new file mode 100644 index 0000000..573cf2f --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_UTF8_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_UTF8_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_UTF8_STRING(str, str_len)
+    SILC_ASN1_UTF8_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_UTF8_STRING(&str, &str_len)
+    SILC_ASN1_UTF8_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode UTF-8 string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The data is also encoded to
+    or decoded from UTF-8.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SILC_ASN1_VISIBLE_STRING.html b/docs/toolkit/manual/silcasn1-SILC_ASN1_VISIBLE_STRING.html new file mode 100644 index 0000000..4bdf467 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SILC_ASN1_VISIBLE_STRING.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_ASN1_VISIBLE_STRING

    + + +SYNOPSIS + +
    
+    Encoding:
+    SILC_ASN1_VISIBLE_STRING(str, str_len)
+    SILC_ASN1_VISIBLE_STRING_T(opts, tag, str, str_len)
+
+    Decoding:
+    SILC_ASN1_VISIBLE_STRING(&str, &str_len)
+    SILC_ASN1_VISIBLE_STRING_T(opts, tag, &str, &str_len)
+
+
    +DESCRIPTION + +
    
+    Macro used to encode or decode visible string.  The string type is
+    unsigned char and string length SilcUInt32.
+
+    The `opts' is SilcAsn1Options.  The `tag' is a tag number.
+
+
    +NOTES + +
    
+    The string must be in UTF-8 encoding when encoding.  The decoded
+    string will be in UTF-8 encoding.  The actual data is encoded to
+    or decoded from visible.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SilcAsn1.html b/docs/toolkit/manual/silcasn1-SilcAsn1.html new file mode 100644 index 0000000..d014714 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SilcAsn1.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAsn1

    + + +NAME + +
    
+    typedef struct SilcAsn1Object *SilcAsn1;
+
+
    +DESCRIPTION + +
    
+    This context is the actual ASN.1 encoder/decoder and is allocated
+    by silc_asn1_alloc and given as argument to all silc_asn1_*
+    functions.  It is freed by the silc_asn1_free function.  It is
+    also possible to use pre-allocated ASN.1 context by using the
+    SilcAsn1Struct instead of SilcAsn1.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SilcAsn1Options.html b/docs/toolkit/manual/silcasn1-SilcAsn1Options.html new file mode 100644 index 0000000..0b281c0 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SilcAsn1Options.html @@ -0,0 +1,305 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAsn1Options

    + + +NAME + +
    
+    typedef enum { ... } SilcAsn1Options;
+
+
    +DESCRIPTION + +
    
+    Options for ASN.1 encoder and decoder.  The ASN.1 options can be
+    given to the SILC_ASN1_*_T macros and/or SILC_ASN1_OPTS macro.
+
+
    +NOTES + +
    
+    The SILC_ASN1_ALLOC and SILC_ASN1_ACCUMUL flags can be given only
+    with SILC_ASN1_OPTS macro.  Other options can be given with various
+    SILC_ASN1_*_T macros.
+
+
    +EXAMPLE + +
    
+    // Encodes boolean value with explicit tag and private class, and
+    // the result is allocated into `dest'.
+    silc_asn1_encode(asn1, &dest,
+                     SILC_ASN1_OPTS(SILC_ASN1_ALLOC),
+                     SILC_ASN1_BOOLEAN_T(SILC_ASN1_PRIVATE |
+                                         SILC_ASN1_EXPLICIT, 100, boolval),
+                     SILC_ASN1_END);
+
+
    +SOURCE + +
        typedef enum {
+      /* Default. If only this is set then defaults are implied. */
+      SILC_ASN1_DEFAULT      = 0x0000,
+    
+      /* Class options.  User does not need to set these unless specificly
+         wanted to do so.  If SILC_ASN1_DEFAULT is set the SILC_ASN1_CONTEXT is
+         implied if any of the tag options are set.  Otherwise SILC_ASN1_UNIVERSAL
+         is implied. Only one of these can bet set at once. */
+      SILC_ASN1_UNIVERSAL    = 0x0001,       /* Universal class (default) */
+      SILC_ASN1_APP          = 0x0002,       /* Application specific class */
+      SILC_ASN1_CONTEXT      = 0x0003,       /* Context specific class */
+      SILC_ASN1_PRIVATE      = 0x0004,       /* Private class */
+    
+      /* Tag options (bitmask) */
+      SILC_ASN1_IMPLICIT     = 0x0010,       /* Tag is implicit (default) */
+      SILC_ASN1_EXPLICIT     = 0x0020,       /* Tag is explicit */
+      SILC_ASN1_DEFINITE     = 0x0040,       /* Length is definite (default) */
+      SILC_ASN1_INDEFINITE   = 0x0080,       /* Length is indefinite */
+    
+      /* Decoding options (bitmask) */
+      SILC_ASN1_OPTIONAL     = 0x0100,       /* Zero or more may be found.  The
+                                                argument must be pointer to the
+                                                type pointer so that NULL can be
+                                                returned if type is not found. */
+    
+      /* ASN.1 encoder/decoder options (bitmask).  These can be given
+         only with SILC_ASN1_OPTS macro at the start of encoding/decoding. */
+      SILC_ASN1_ALLOC        = 0x0400,       /* Dynamically allocate results */
+      SILC_ASN1_ACCUMUL      = 0x0800,       /* Accumulate memory for results,
+                                                next call to silc_asn1_decode
+                                                will not cancel old results. */
+    } SilcAsn1Options;
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SilcAsn1Struct.html b/docs/toolkit/manual/silcasn1-SilcAsn1Struct.html new file mode 100644 index 0000000..daf085b --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SilcAsn1Struct.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAsn1Struct

    + + +NAME + +
    
+    typedef struct SilcAsn1Object SilcAsn1Struct;
+
+
    +DESCRIPTION + +
    
+    This context is the actual ASN.1 encoder/decoder and can be
+    used as pre-allocated ASN.1 context instead of SilcAsn1 context.
+    This context is initialized with silc_asn1_init and uninitialized
+    with silc_asn1_uninit.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-SilcAsn1Tag.html b/docs/toolkit/manual/silcasn1-SilcAsn1Tag.html new file mode 100644 index 0000000..8be951d --- /dev/null +++ b/docs/toolkit/manual/silcasn1-SilcAsn1Tag.html @@ -0,0 +1,285 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAsn1Tag

    + + +NAME + +
    
+    typedef enum { ... } SilcAsn1Tag;
+
+
    +DESCRIPTION + +
    
+    Universal ASN.1 tags.  Usually these tags are given automatically
+    to the silc_asn1_encode and silc_asn1_decode by using the various
+    macros (such as SILC_ASN1_BOOLEAN).  Some macros may take the tag
+    as additional argument.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_ASN1_TAG_BOOLEAN               = 1,  /* SILC_ASN1_BOOLEAN */
+      SILC_ASN1_TAG_INTEGER               = 2,  /* SILC_ASN1_INT */
+      SILC_ASN1_TAG_BIT_STRING            = 3,  /* SILC_ASN1_BIT_STRING */
+      SILC_ASN1_TAG_OCTET_STRING          = 4,  /* SILC_ASN1_OCTET_STRING */
+      SILC_ASN1_TAG_NULL                  = 5,  /* SILC_ASN1_NULL */
+      SILC_ASN1_TAG_OID                   = 6,  /* SILC_ASN1_OID */
+      SILC_ASN1_TAG_ODE                   = 7,  /* not supported */
+      SILC_ASN1_TAG_ETI                   = 8,  /* not supported */
+      SILC_ASN1_TAG_REAL                  = 9,  /* not supported */
+      SILC_ASN1_TAG_ENUM                  = 10, /* SILC_ASN1_ENUM */
+      SILC_ASN1_TAG_EMBEDDED              = 11, /* not supported */
+      SILC_ASN1_TAG_UTF8_STRING           = 12, /* SILC_ASN1_UTF8_STRING */
+      SILC_ASN1_TAG_ROI                   = 13, /* not supported */
+      SILC_ASN1_TAG_SEQUENCE              = 16, /* SILC_ASN1_SEQUENCE */
+      SILC_ASN1_TAG_SET                   = 17, /* SILC_ASN1_SET */
+      SILC_ASN1_TAG_NUMERIC_STRING        = 18, /* SILC_ASN1_NUMERIC_STRING */
+      SILC_ASN1_TAG_PRINTABLE_STRING      = 19, /* SILC_ASN1_PRINTABLE_STRING */
+      SILC_ASN1_TAG_TELETEX_STRING        = 20, /* SILC_ASN1_TELETEX_STRING */
+      SILC_ASN1_TAG_VIDEOTEX_STRING       = 21, /* not supported */
+      SILC_ASN1_TAG_IA5_STRING            = 22, /* SILC_ASN1_IA5_STRING */
+      SILC_ASN1_TAG_UTC_TIME              = 23, /* SILC_ASN1_UTC_TIME */
+      SILC_ASN1_TAG_GENERALIZED_TIME      = 24, /* SILC_ASN1_GENERAL_STRING */
+      SILC_ASN1_TAG_GRAPHIC_STRING        = 25, /* not supported */
+      SILC_ASN1_TAG_VISIBLE_STRING        = 26, /* SILC_ASN1_VISIBLE_STRING */
+      SILC_ASN1_TAG_GENERAL_STRING        = 27, /* SILC_ASN1_GENERAL_STRING */
+      SILC_ASN1_TAG_UNIVERSAL_STRING      = 28, /* SILC_ASN1_UNIVERSAL_STRING */
+      SILC_ASN1_TAG_UNRESTRICTED_STRING   = 29, /* SILC_ASN1_UNRESTRICTED_STRING */
+      SILC_ASN1_TAG_BMP_STRING            = 30, /* SILC_ASN1_BMP_STRING */
+    } SilcAsn1Tag;
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-silc_asn1_alloc.html b/docs/toolkit/manual/silcasn1-silc_asn1_alloc.html new file mode 100644 index 0000000..d7b1fea --- /dev/null +++ b/docs/toolkit/manual/silcasn1-silc_asn1_alloc.html @@ -0,0 +1,262 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_asn1_alloc

    + + +SYNOPSIS + +
    
+    SilcAsn1 silc_asn1_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates and initializes ASN.1 encoder/decoder and returns SilcAsn1
+    context or NULL on error.  This context can be used with both
+    silc_asn1_encode and silc_asn1_decode functions.
+
+    Usually SilcAsn1 is allocated when encoder or decoder is needed,
+    however it is also possible to allocate long-lasting SilcAsn1 and
+    use that every time ASN.1 routines are needed.  Application could
+    for example allocate one SilcAsn1 and use that for all ASN.1 encoding
+    and decoding.
+
+    When this context is freed with silc_asn1_free all memory will be
+    freed, and all encoded ASN.1 buffers becomes invalid.  Also all
+    data that is returned by silc_asn1_decode function becomes invalid.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-silc_asn1_decode.html b/docs/toolkit/manual/silcasn1-silc_asn1_decode.html new file mode 100644 index 0000000..a1fb83d --- /dev/null +++ b/docs/toolkit/manual/silcasn1-silc_asn1_decode.html @@ -0,0 +1,296 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_asn1_decode

    + + +SYNOPSIS + +
    
+    SilcBool silc_asn1_decode(SilcAsn1 asn1, SilcBuffer src, ...);
+
+
    +DESCRIPTION + +
    
+    Decodes the ASN.1 encoded buffer `src' by the ASN.1 types sent
+    as argument.  The ASN.1 types sent as argument must be found from
+    the `src' for this function to decode successfully.
+
+    The memory allocated for the results are allocated from `asn1' and
+    they become invalid if `asn1' becomes invalid.  Next (second) call
+    to this function does NOT invalidate the previous results.  However,
+    third call to this function does invalidate the results of the first
+    call but not second.  On the other hand, fourth call invalidates
+    the results of the second call but not third, fifth call invalidates
+    the results of the third call but not fourth, and so on.  This allows
+    efficient decoding, when silc_asn1_decode must be called multiple times
+    to decode all data, without new memory allocations.  However, caller
+    must be cautios and understand that the every second call invalidates
+    the results of every second previous results.
+
+    If the SILC_ASN1_OPTS macro with SILC_ASN1_ALLOC option is given then
+    all results are dynamically allocated and caller must free them by
+    itself. Alternatively if SILC_ASN1_ACCUMUL is given then memory is
+    accumulated from `asn1' for results and they are freed only when the
+    silc_asn1_free or silc_asn1_uninit is called.  Next calls to the
+    silc_asn1_decode will NOT invalidate the old results, but will
+    accumulate more memory for new results.  If the SILC_ASN1_OPTS is not
+    given at all then the default allocation method (decribed above)
+    applies.
+
+    If caller needs to store the results even after `asn1' becomes invalid
+    then call must either use SILC_ASN1_ALLOC option or duplicate the
+    results by itself.
+
+
    +EXAMPLE + +
    
+    SilcBool bool_val, foo;
+    unsigned char *string, string2;
+    SilcUInt32 string_len, string2_len;
+
+    silc_asn1_decode(asn1, tree,
+                     SILC_ASN1_SEQUENCE,
+                       SILC_ASN1_BOOLEAN(&bool_val),
+                       SILC_ASN1_OCTET_STRING(&string, &string_len),
+                       SILC_ASN1_SEQUENCE_T(0, 2),
+                         SILC_ASN1_BOOLEAN_T(SILC_ASN1_EXPLICIT, 100, &foo),
+                       SILC_ASN1_END,
+                       SILC_ASN1_OCTET_STRING_T(0, 1, &str2, &str2_len),
+                     SILC_ASN1_END, SILC_ASN1_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-silc_asn1_encode.html b/docs/toolkit/manual/silcasn1-silc_asn1_encode.html new file mode 100644 index 0000000..f42f0d6 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-silc_asn1_encode.html @@ -0,0 +1,292 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_asn1_encode

    + + +SYNOPSIS + +
    
+    SilcBool silc_asn1_encode(SilcAsn1 asn1, SilcBuffer dest, ...);
+
+
    +DESCRIPTION + +
    
+    Encodes ASN.1 encoded buffer into `dest', from variable argument
+    list of ASN.1 types.  The variable argument list forms the ASN.1
+    trees and nodes that are encoded into the `dest'.  By default, the
+    memory for `dest' is allocated from the `asn1', and the buffer becomes
+    invalid either by calling silc_asn1_free, silc_asn1_uninit, or when
+    silc_asn1_encode is called for the next time.
+
+    If the SILC_ASN1_OPTS macro with SILC_ASN1_ALLOC option is given then
+    the `dest' is dynamically allocated and caller must free it by itself.
+    Alternatively if SILC_ASN1_ACCUMUL is given then memory is accumulated
+    from `asn1' for `dest' and it is freed only when silc_asn1_free or
+    silc_asn1_uninit is called.  Next call to silc_asn1_encode will not
+    cancel the previous result, but will accumulate more memory for new
+    result.
+
+    The variable argument list is constructed by using various
+    macros, for example SILC_ASN1_SEQUENCE, etc.  The variable argument
+    list must always be ended with SILC_ASN1_END type.
+
+    If encoding is successful this returns TRUE, FALSE on error.
+
+
    +EXAMPLE + +
    
+    silc_asn1_encode(asn1, buf,
+                     SILC_ASN1_SEQUENCE,
+                       SILC_ASN1_BOOLEAN(bool_val),
+                       SILC_ASN1_OCTET_STRING(string, string_len),
+                       SILC_ASN1_SEQUENCE_T(0, 2),
+                         SILC_ASN1_BOOLEAN_T(SILC_ASN1_EXPLICIT, 100, foo),
+                       SILC_ASN1_END,
+                       SILC_ASN1_OCTET_STRING_T(0, 1, string2, string2_len),
+                     SILC_ASN1_END, SILC_ASN1_END);
+
+    Creates ASN.1 tree that looks something like:
+
+    buf ::= SEQUENCE {
+      bool_val      BOOLEAN,
+      string        OCTET-STRING,
+               [2]  SEQUENCE {
+                      foo   [100] EXPLICIT BOOLEAN }
+      string2  [1]  OCTET-STRING }
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-silc_asn1_free.html b/docs/toolkit/manual/silcasn1-silc_asn1_free.html new file mode 100644 index 0000000..f532cbf --- /dev/null +++ b/docs/toolkit/manual/silcasn1-silc_asn1_free.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_asn1_free

    + + +SYNOPSIS + +
    
+    void silc_asn1_free(SilcAsn1 asn1);
+
+
    +DESCRIPTION + +
    
+    Frees the SilcAsn1 context and all allocated memory.  All encoded
+    buffers and all decoded buffers with this context becomes invalid
+    after this call.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-silc_asn1_init.html b/docs/toolkit/manual/silcasn1-silc_asn1_init.html new file mode 100644 index 0000000..9921d32 --- /dev/null +++ b/docs/toolkit/manual/silcasn1-silc_asn1_init.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_asn1_init

    + + +SYNOPSIS + +
    
+    SilcBool silc_asn1_init(SilcAsn1 asn1);
+
+
    +DESCRIPTION + +
    
+    Initializes a pre-allocated SilcAsn1 context.  This call is
+    equivalent to silc_asn1_alloc except that this takes the pre-allocated
+    context as argument.
+
+
    +EXAMPLE + +
    
+    SilcAsn1Struct asn1;
+    if (!silc_asn1_init(&asn1))
+      error;
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1-silc_asn1_uninit.html b/docs/toolkit/manual/silcasn1-silc_asn1_uninit.html new file mode 100644 index 0000000..ffe6b2c --- /dev/null +++ b/docs/toolkit/manual/silcasn1-silc_asn1_uninit.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_asn1_uninit

    + + +SYNOPSIS + +
    
+    void silc_asn1_uninit(SilcAsn1 asn1);
+
+
    +DESCRIPTION + +
    
+    Uninitializes a pre-allocated SilcAsn1 context.  Use this function
+    instead of silc_asn1_free if you used silc_asn1_init.
+
+
    +



    +
    +     		+ + + + +
    +
    + +ASN.1 Interface
    +SilcAsn1
    +SilcAsn1Struct
    +SilcAsn1Options
    +SilcAsn1Tag
    +silc_asn1_alloc
    +silc_asn1_free
    +silc_asn1_init
    +silc_asn1_uninit
    +silc_asn1_encode
    +silc_asn1_decode
    +SILC_ASN1_OPTS
    +SILC_ASN1_ANY
    +SILC_ASN1_ANY_PRIMITIVE
    +SILC_ASN1_SEQUENCE
    +SILC_ASN1_SET
    +SILC_ASN1_SEQUENCE_OF
    +SILC_ASN1_SET_OF
    +SILC_ASN1_CHOICE
    +SILC_ASN1_BOOLEAN
    +SILC_ASN1_INT
    +SILC_ASN1_SHORT_INT
    +SILC_ASN1_ENUM
    +SILC_ASN1_BIT_STRING
    +SILC_ASN1_NULL
    +SILC_ASN1_OID
    +SILC_ASN1_OCTET_STRING
    +SILC_ASN1_UTF8_STRING
    +SILC_ASN1_NUMERIC_STRING
    +SILC_ASN1_PRINTABLE_STRING
    +SILC_ASN1_TELETEX_STRING
    +SILC_ASN1_IA5_STRING
    +SILC_ASN1_VISIBLE_STRING
    +SILC_ASN1_UNIVERSAL_STRING
    +SILC_ASN1_BMP_STRING
    +SILC_ASN1_UNRESTRICTED_STRING
    +SILC_ASN1_GENERAL_STRING
    +SILC_ASN1_UTC_TIME
    +SILC_ASN1_GEN_TIME
    +SILC_ASN1_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1.html b/docs/toolkit/manual/silcasn1.html new file mode 100644 index 0000000..2e7015b --- /dev/null +++ b/docs/toolkit/manual/silcasn1.html @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcasn1.html + + + + +
    + +ASN.1 Interface
    Header: silcasn1.h

    + + +DESCRIPTION + +
    
+ Efficient Abstract Syntax Notation One (ASN.1) implementation.  This
+ interface provides simple and efficient ASN.1 encoder and decoder.
+ The encoder directly encodes BER encoded data blocks from variable
+ argument list of ASN.1 types.  Multiple trees can be encoded at once
+ and multiple nodes can be encoded into the tree at once.  By default
+ encoder does not allocate any memory during encoding but a pre-allocated
+ SilcStack is used as memory.
+
+ The decoder directly decodes BER encoded data blocks into the correct
+ types dictated by the variable argument list of ASN.1 types.  By
+ default decoder does not allocate any memory during decoding but a
+ pre-allocated SilcStack is used as memory.
+
+ The encoding and decoding interface is simple.  silc_asn1_encode is used
+ to encode and silc_asn1_decode to decode.  The actual ASN.1 is defined
+ as variable argument list to the function.  Various macros can be used
+ to encode and decode different ASN.1 types.  All types may also be used
+ to encode and decode with various options (such as implicit and explicit
+ tagging and defining specific class option).
+
+ The implementation supports all the common ASN.1 types.  This
+ implementation does not support advanced ASN.1 features like macros.
+
+ References: ITU-T X.680 - X.693
+ http://www.itu.int/ITU-T/studygroups/com17/languages/
+
+
  • SilcAsn1 +
  • SilcAsn1Struct +
  • SilcAsn1Options +
  • SilcAsn1Tag +
  • silc_asn1_alloc +
  • silc_asn1_free +
  • silc_asn1_init +
  • silc_asn1_uninit +
  • silc_asn1_encode +
  • silc_asn1_decode +
  • SILC_ASN1_OPTS +
  • SILC_ASN1_ANY +
  • SILC_ASN1_ANY_PRIMITIVE +
  • SILC_ASN1_SEQUENCE +
  • SILC_ASN1_SET +
  • SILC_ASN1_SEQUENCE_OF +
  • SILC_ASN1_SET_OF +
  • SILC_ASN1_CHOICE +
  • SILC_ASN1_BOOLEAN +
  • SILC_ASN1_INT +
  • SILC_ASN1_SHORT_INT +
  • SILC_ASN1_ENUM +
  • SILC_ASN1_BIT_STRING +
  • SILC_ASN1_NULL +
  • SILC_ASN1_OID +
  • SILC_ASN1_OCTET_STRING +
  • SILC_ASN1_UTF8_STRING +
  • SILC_ASN1_NUMERIC_STRING +
  • SILC_ASN1_PRINTABLE_STRING +
  • SILC_ASN1_TELETEX_STRING +
  • SILC_ASN1_IA5_STRING +
  • SILC_ASN1_VISIBLE_STRING +
  • SILC_ASN1_UNIVERSAL_STRING +
  • SILC_ASN1_BMP_STRING +
  • SILC_ASN1_UNRESTRICTED_STRING +
  • SILC_ASN1_GENERAL_STRING +
  • SILC_ASN1_UTC_TIME +
  • SILC_ASN1_GEN_TIME +
  • SILC_ASN1_END + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1.xref b/docs/toolkit/manual/silcasn1.xref new file mode 100644 index 0000000..6c232f3 --- /dev/null +++ b/docs/toolkit/manual/silcasn1.xref @@ -0,0 +1,46 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcasn1.h" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 0 + "ASN.1 Interface" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 1 + "SilcAsn1" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 5 + "SilcAsn1Struct" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 5 + "SilcAsn1Options" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 8 + "SilcAsn1Tag" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 8 + "silc_asn1_alloc" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "silc_asn1_free" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "silc_asn1_init" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "silc_asn1_uninit" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "silc_asn1_encode" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "silc_asn1_decode" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_OPTS" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_ANY" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_ANY_PRIMITIVE" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_SEQUENCE" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_SET" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_SEQUENCE_OF" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_SET_OF" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_CHOICE" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_BOOLEAN" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_INT" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_SHORT_INT" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_ENUM" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_BIT_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_NULL" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_OID" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_OCTET_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_UTF8_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_NUMERIC_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_PRINTABLE_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_TELETEX_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_IA5_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_VISIBLE_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_UNIVERSAL_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_BMP_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_UNRESTRICTED_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_GENERAL_STRING" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_UTC_TIME" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_GEN_TIME" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + "SILC_ASN1_END" "/home/priikone/silc1/doc/toolkit/silcasn1.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcasn1_i.html b/docs/toolkit/manual/silcasn1_i.html new file mode 100644 index 0000000..e5b6465 --- /dev/null +++ b/docs/toolkit/manual/silcasn1_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcasn1_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasn1_i.xref b/docs/toolkit/manual/silcasn1_i.xref new file mode 100644 index 0000000..a741a76 --- /dev/null +++ b/docs/toolkit/manual/silcasn1_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcasn1_i.h" "/home/priikone/silc1/doc/toolkit/silcasn1_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcasn1lib.html b/docs/toolkit/manual/silcasn1lib.html new file mode 100644 index 0000000..c9240ff --- /dev/null +++ b/docs/toolkit/manual/silcasn1lib.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC ASN.1 Library +
    +Directory: lib/silcasn1/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Abstract Syntax Notation One (ASN.1) Library provides interface for +efficient ASN.1 encoder and decoder. The library also provides BER/DER +encoder and decoder. + +

    + +
  • SILC ASN.1 Interface +
  • SILC BER interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-SilcAsyncOperation.html b/docs/toolkit/manual/silcasync-SilcAsyncOperation.html new file mode 100644 index 0000000..2fb176e --- /dev/null +++ b/docs/toolkit/manual/silcasync-SilcAsyncOperation.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAsyncOperation

    + + +NAME + +
    
+    typedef struct SilcAsyncOperationObject *SilcAsyncOperation;
+
+
    +DESCRIPTION + +
    
+    The asynchronous operation context allocated by silc_async_alloc.
+    The layer that implements the asynchronous operation allocates this
+    context.  The layer that receives this context can use it to control
+    the underlaying asynchronous operation.  It is also possible to use
+    a pre-allocated context by using SilcAsyncOperationStruct instead
+    SilcAsyncOperation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-SilcAsyncOperationAbort.html b/docs/toolkit/manual/silcasync-SilcAsyncOperationAbort.html new file mode 100644 index 0000000..b48497f --- /dev/null +++ b/docs/toolkit/manual/silcasync-SilcAsyncOperationAbort.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcAsyncOperationAbort

    + + +SYNOPSIS + +
    
+    typedef void (*SilcAsyncOperationAbort)(SilcAsyncOperation op,
+                                            void *context);
+
+
    +DESCRIPTION + +
    
+    This callback is called when upper layer calls the silc_async_abort,
+    and is used to actually perform the abortion of the asynchronous
+    operation.  The silc_async_free must not be called in this function.
+
+    This callback type can also be provided to silc_async_abort function
+    by the upper layer, if it wants that callback is called to the upper
+    layer when aborting the operation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-SilcAsyncOperationPause.html b/docs/toolkit/manual/silcasync-SilcAsyncOperationPause.html new file mode 100644 index 0000000..515411b --- /dev/null +++ b/docs/toolkit/manual/silcasync-SilcAsyncOperationPause.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcAsyncOperationPause

    + + +SYNOPSIS + +
    
+    typedef SilcBool (*SilcAsyncOperationPause)(SilcAsyncOperation op,
+                                                SilcBool pause_operation,
+                                                void *context);
+
+
    +DESCRIPTION + +
    
+    This callback is used to halt an operation, if upper layer calls the
+    silc_async_halt function, or to resume an operation if upper layer
+    calls the silc_async_resume, after it has earlier halted the operation.
+    If this callback is implemented it is guaranteed that the asynchronous
+    operation is not progressed when it is halted.  If the `pause_operation'
+    is TRUE the operation is halted.  If it is FALSE, then the operation
+    resumes its execution.  This function returns TRUE if the operation
+    was (or is going to be) halted or resumed, and FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-SilcAsyncOperationStruct.html b/docs/toolkit/manual/silcasync-SilcAsyncOperationStruct.html new file mode 100644 index 0000000..29ea20f --- /dev/null +++ b/docs/toolkit/manual/silcasync-SilcAsyncOperationStruct.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAsyncOperationStruct

    + + +NAME + +
    
+    typedef struct SilcAsyncOperationObject SilcAsyncOperationStruct;
+
+
    +DESCRIPTION + +
    
+    The asynchronous operation context that can be used as a pre-allocated
+    context.  This is initialized with silc_async_init.  It need not
+    be uninitialized.  The layer that implements the asynchronous
+    operation initializes this context.  The layer that has access to this
+    context can use it to control the underlaying asynchronous operation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-silc_async_abort.html b/docs/toolkit/manual/silcasync-silc_async_abort.html new file mode 100644 index 0000000..af28872 --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_abort.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_async_abort

    + + +SYNOPSIS + +
    
+    void silc_async_abort(SilcAsyncOperation op,
+                          SilcAsyncOperationAbort abort_cb, void *context);
+
+
    +DESCRIPTION + +
    
+    This function is used by upper layer that received SilcAsyncOperation
+    context from an asynchronous function, to abort the asynchronous
+    operation.  The `op' becomes invalid after this function returns.
+    It is also guaranteed (assuming the use of this API is implemented
+    correctly) that some other completion callback is not called after
+    the operation was aborted.  However, if the caller wants to receive
+    a callback when aborting the caller may specify the `abort_cb' and
+    `context' which will be called after the operation is aborted, but
+    before the `op' becomes invalid.  The `abort_cb' is called immediately
+    inside this function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-silc_async_alloc.html b/docs/toolkit/manual/silcasync-silc_async_alloc.html new file mode 100644 index 0000000..6834ab5 --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_alloc.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_async_alloc

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation silc_async_alloc(SilcAsyncOperationAbort abort_cb,
+                                        SilcAsyncOperationPause pause_cb,
+                                        void *context);
+
+
    +DESCRIPTION + +
    
+    Start asynchronous operation, and assign `abort_cb' callback for it,
+    which can be used by some upper layer to abort the asynchronous
+    operation, by calling the silc_async_abort.  The layer which calls
+    this function must also call silc_async_free when the asynchronous
+    operation is successfully completed.  If it is aborted by upper layer
+    then silc_async_free must not be called, since it is called by the
+    silc_async_abort function.
+
+    If the `pause_cb' is provided then the upper layer may also halt and
+    then later resume the execution of the operation, by calling the
+    silc_async_halt and silc_async_resume respectively.  If `pause_cb' is
+    not provided then these functions has no effect for this operation.
+
+
    +EXAMPLE + +
    
+    SilcAsyncOperation silc_async_call(Callback callback, void *cb_context)
+    {
+      SilcAsyncOperation op;
+      ...
+
+      // Allocate async operation so that caller can control us, like abort
+      op = silc_async_alloc(silc_async_call_abort, NULL, ctx);
+
+      // Start async operation in FSM
+      silc_fsm_init(&ctx->fsm, ctx, fsm_destructor, ctx, schedule);
+      silc_fsm_start(&ctx->fsm, first_state);
+      ...
+
+      // Return async operation for upper layer
+      return op;
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-silc_async_free.html b/docs/toolkit/manual/silcasync-silc_async_free.html new file mode 100644 index 0000000..0526027 --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_free.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_async_free

    + + +SYNOPSIS + +
    
+    void silc_async_free(SilcAsyncOperation op);
+
+
    +DESCRIPTION + +
    
+    Stop the asynchronous operation.  If the asynchronous operation ended
+    normally (ie. it was not aborted) this function must be called by the
+    caller who called silc_async_alloc.  The `op' will become invalid after
+    this and the upper layer must not call silc_async_abort after this
+    function is called.  The layer that calls this, must call some other
+    completion callback to the upper layer, so that it knows that the
+    asynchronous operation is completed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-silc_async_get_context.html b/docs/toolkit/manual/silcasync-silc_async_get_context.html new file mode 100644 index 0000000..020e610 --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_get_context.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_async_get_context

    + + +SYNOPSIS + +
    
+    void *silc_async_get_context(SilcAsyncOperation op);
+
+
    +DESCRIPTION + +
    
+    Returns the context that was given to the silc_async_alloc or
+    silc_async_init.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-silc_async_halt.html b/docs/toolkit/manual/silcasync-silc_async_halt.html new file mode 100644 index 0000000..50b903a --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_halt.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_async_halt

    + + +SYNOPSIS + +
    
+    SilcBool silc_async_halt(SilcAsyncOperation op);
+
+
    +DESCRIPTION + +
    
+    Halt the execution of the asynchronous operation.  If the operation
+    supports this feature, it is guaranteed that the operation is halted
+    and its execution is not progressed until the silc_async_resume function
+    is called.  The operation still can be aborted even if it is halted.
+    If this function is not supported, calling this has no effect and the
+    function returns FALSE.  This function is for the upper layer that
+    controls the asynchronous operation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-silc_async_init.html b/docs/toolkit/manual/silcasync-silc_async_init.html new file mode 100644 index 0000000..8633357 --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_init.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_async_init

    + + +SYNOPSIS + +
    
+    SilcBool silc_async_init(SilcAsyncOperation op,
+                             SilcAsyncOperationAbort abort_cb,
+                             SilcAsyncOperationPause pause_cb,
+                             void *context);
+
+
    +DESCRIPTION + +
    
+    Initializes and starts a pre-allocated asynchronous operation context,
+    and assigns `abort_cb' callback for it, which can be used by some upper
+    layer to abort the asynchronous operation, by calling the
+    silc_async_abort.  Since this use pre-allocated context, the function
+    silc_async_free need not be called.  This function is equivalent
+    to silc_async_alloc except this does not allocate any memory.  The `op'
+    needs not be uninitialized.
+
+    If the `pause_cb' is provided then the upper layer may also halt and
+    then later resume the execution of the operation, by calling the
+    silc_async_halt and silc_async_resume respectively.  If `pause_cb' is
+    not provided then these functions has no effect for this operation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync-silc_async_resume.html b/docs/toolkit/manual/silcasync-silc_async_resume.html new file mode 100644 index 0000000..9b55bd1 --- /dev/null +++ b/docs/toolkit/manual/silcasync-silc_async_resume.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_async_resume

    + + +SYNOPSIS + +
    
+    SilcBool silc_async_resume(SilcAsyncOperation op);
+
+
    +DESCRIPTION + +
    
+    Resume the execution of the asynchronous operation.  If the halting of
+    the operation was supported, then this function is used to resume the
+    execution of the operation after it was halted.  If this function is
+    not supported, calling this has no effect and the function returns
+    FALSE.  This function is for the upper layer that controls the
+    asynchronous operation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Async Operation Interface
    +SilcAsyncOperation
    +SilcAsyncOperationStruct
    +SilcAsyncOperationAbort
    +SilcAsyncOperationPause
    +silc_async_halt
    +silc_async_resume
    +silc_async_abort
    +silc_async_alloc
    +silc_async_init
    +silc_async_free
    +silc_async_get_context
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync.html b/docs/toolkit/manual/silcasync.html new file mode 100644 index 0000000..37f0e71 --- /dev/null +++ b/docs/toolkit/manual/silcasync.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcasync.html + + + + +
    + +SILC Async Operation Interface
    Header: silcasync.h

    + + +DESCRIPTION + +
    
+ SILC Async Operation API is an interface that can be used to control
+ asynchronous operations.  All functions that take callback as argument
+ should return SilcAsyncOperation context.  That context then can be
+ used to control, such as, abort the asynchronous operation.  Using
+ SILC Async Operation API, asynchronous functions can be controlled
+ and aborted safely.
+
+ The SILC Async Operation API is divided in two levels; the underlaying
+ operation level that implements the asynchronous operation, and the
+ upper layer that can control the asynchronous operation.  The operation
+ layer must guarantee that if the upper layer aborts the asynchronous
+ operation, no callback function will be called back to the upper layer.
+ This must be remembered when implementing the operation layer.
+
+
  • SilcAsyncOperation +
  • SilcAsyncOperationStruct +
  • SilcAsyncOperationAbort +
  • SilcAsyncOperationPause +
  • silc_async_halt +
  • silc_async_resume +
  • silc_async_abort +
  • silc_async_alloc +
  • silc_async_init +
  • silc_async_free +
  • silc_async_get_context + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync.xref b/docs/toolkit/manual/silcasync.xref new file mode 100644 index 0000000..c370d51 --- /dev/null +++ b/docs/toolkit/manual/silcasync.xref @@ -0,0 +1,18 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcasync.h" "/home/priikone/silc1/doc/toolkit/silcasync.html" 0 + "SILC Async Operation Interface" "/home/priikone/silc1/doc/toolkit/silcasync.html" 1 + "SilcAsyncOperation" "/home/priikone/silc1/doc/toolkit/silcasync.html" 5 + "SilcAsyncOperationStruct" "/home/priikone/silc1/doc/toolkit/silcasync.html" 5 + "SilcAsyncOperationAbort" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "SilcAsyncOperationPause" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "silc_async_halt" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "silc_async_resume" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "silc_async_abort" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "silc_async_alloc" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "silc_async_init" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "silc_async_free" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + "silc_async_get_context" "/home/priikone/silc1/doc/toolkit/silcasync.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcasync_i.html b/docs/toolkit/manual/silcasync_i.html new file mode 100644 index 0000000..107f758 --- /dev/null +++ b/docs/toolkit/manual/silcasync_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcasync_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcasync_i.xref b/docs/toolkit/manual/silcasync_i.xref new file mode 100644 index 0000000..fd944f3 --- /dev/null +++ b/docs/toolkit/manual/silcasync_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcasync_i.h" "/home/priikone/silc1/doc/toolkit/silcasync_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcatomic-SilcAtomic16.html b/docs/toolkit/manual/silcatomic-SilcAtomic16.html new file mode 100644 index 0000000..7682095 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-SilcAtomic16.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAtomic16

    + + +NAME + +
    
+    typedef struct { ... } SilcAtomic16;
+
+
    +DESCRIPTION + +
    
+    The atomic operation structure given as argument to all atomic
+    operation functions.  It hols the actual 16-bit atomic variable.
+
+
    +EXAMPLE + +
    
+    SilcAtomic16 refcnt;
+
+    // Initialize atomic variable
+    silc_atomic_init16(&refcnt, 0);
+
+    ...
+    // Increment referene counter
+    silc_atomic_add_int16(&refcnt, 1);
+    ...
+
+    // Uninitialize atomic variable
+    silc_atomic_uninit16(&refcnt);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-SilcAtomic32.html b/docs/toolkit/manual/silcatomic-SilcAtomic32.html new file mode 100644 index 0000000..0f710e6 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-SilcAtomic32.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAtomic32

    + + +NAME + +
    
+    typedef struct { ... } SilcAtomic32;
+
+
    +DESCRIPTION + +
    
+    The atomic operation structure given as argument to all atomic
+    operation functions.  It hols the actual 32-bit atomic variable.
+
+
    +EXAMPLE + +
    
+    SilcAtomic32 refcnt;
+
+    // Initialize atomic variable
+    silc_atomic_init32(&refcnt, 0);
+
+    ...
+    // Increment referene counter
+    silc_atomic_add_int32(&refcnt, 1);
+    ...
+
+    // Uninitialize atomic variable
+    silc_atomic_uninit32(&refcnt);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-SilcAtomic8.html b/docs/toolkit/manual/silcatomic-SilcAtomic8.html new file mode 100644 index 0000000..b86df25 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-SilcAtomic8.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAtomic8

    + + +NAME + +
    
+    typedef struct { ... } SilcAtomic8;
+
+
    +DESCRIPTION + +
    
+    The atomic operation structure given as argument to all atomic
+    operation functions.  It hols the actual 8-bit atomic variable.
+
+
    +EXAMPLE + +
    
+    SilcAtomic8 refcnt;
+
+    // Initialize atomic variable
+    silc_atomic_init8(&refcnt, 0);
+
+    ...
+    // Increment referene counter
+    silc_atomic_add_int8(&refcnt, 1);
+    ...
+
+    // Uninitialize atomic variable
+    silc_atomic_uninit8(&refcnt);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-SilcAtomicPointer.html b/docs/toolkit/manual/silcatomic-SilcAtomicPointer.html new file mode 100644 index 0000000..a9d57eb --- /dev/null +++ b/docs/toolkit/manual/silcatomic-SilcAtomicPointer.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAtomicPointer

    + + +NAME + +
    
+    typedef struct { ... } SilcAtomicPointer;
+
+
    +DESCRIPTION + +
    
+    The atomic operation structure given as argument to all atomic
+    operation functions.  It hols the actual pointer variable.
+
+
    +EXAMPLE + +
    
+    SilcAtomicPointer ptr;
+
+    // Initialize atomic variable
+    silc_atomic_init_pointer(&ptr, NULL);
+
+    ...
+    // Set pointer
+    silc_atomic_set_pointer(&ptr, context);
+    ...
+
+    // Uninitialize atomic variable
+    silc_atomic_uninit_pointer(&ptr);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_add_int16.html b/docs/toolkit/manual/silcatomic-silc_atomic_add_int16.html new file mode 100644 index 0000000..43e66b0 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_add_int16.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_add_int16

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt16 silc_atomic_add_int16(SilcAtomic16 *atomic, SilcInt16 value);
+
+
    +DESCRIPTION + +
    
+    Atomically adds `value' to 16-bit integer.  Returns the value after
+    addition.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_add_int32.html b/docs/toolkit/manual/silcatomic-silc_atomic_add_int32.html new file mode 100644 index 0000000..166f644 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_add_int32.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_add_int32

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt32 silc_atomic_add_int32(SilcAtomic32 *atomic, SilcInt32 value);
+
+
    +DESCRIPTION + +
    
+    Atomically adds `value' to 32-bit integer.  Returns the value after
+    addition.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_add_int8.html b/docs/toolkit/manual/silcatomic-silc_atomic_add_int8.html new file mode 100644 index 0000000..c7d9277 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_add_int8.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_add_int8

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt8 silc_atomic_add_int8(SilcAtomic8 *atomic, SilcInt8 value);
+
+
    +DESCRIPTION + +
    
+    Atomically adds `value' to 8-bit integer.  Returns the value after
+    addition.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_cas16.html b/docs/toolkit/manual/silcatomic-silc_atomic_cas16.html new file mode 100644 index 0000000..404be3a --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_cas16.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_cas16

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_cas16(SilcAtomic16 *atomic, SilcUInt16 old_val,
+                               SilcUInt16 new_val)
+
+
    +DESCRIPTION + +
    
+    Performs compare and swap (CAS).  Atomically compares if the variable
+    `atomic' has the value `old_val' and in that case swaps it with the
+    value `new_val'.  Returns TRUE if the old value was same and it was
+    swapped and FALSE if it differed and was not swapped.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_cas32.html b/docs/toolkit/manual/silcatomic-silc_atomic_cas32.html new file mode 100644 index 0000000..2426c25 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_cas32.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_cas32

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_cas32(SilcAtomic32 *atomic, SilcUInt32 old_val,
+                               SilcUInt32 new_val)
+
+
    +DESCRIPTION + +
    
+    Performs compare and swap (CAS).  Atomically compares if the variable
+    `atomic' has the value `old_val' and in that case swaps it with the
+    value `new_val'.  Returns TRUE if the old value was same and it was
+    swapped and FALSE if it differed and was not swapped.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_cas8.html b/docs/toolkit/manual/silcatomic-silc_atomic_cas8.html new file mode 100644 index 0000000..c2201ce --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_cas8.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_cas8

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_cas8(SilcAtomic8 *atomic, SilcUInt8 old_val,
+                              SilcUInt8 new_val)
+
+
    +DESCRIPTION + +
    
+    Performs compare and swap (CAS).  Atomically compares if the variable
+    `atomic' has the value `old_val' and in that case swaps it with the
+    value `new_val'.  Returns TRUE if the old value was same and it was
+    swapped and FALSE if it differed and was not swapped.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_cas_pointer.html b/docs/toolkit/manual/silcatomic-silc_atomic_cas_pointer.html new file mode 100644 index 0000000..0bb138b --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_cas_pointer.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_cas_pointer

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_cas_pointer(SilcAtomicPointer *atomic,
+                                     void *old_ptr, void *new_ptr);
+
+
    +DESCRIPTION + +
    
+    Performs compare and swap (CAS).  Atomically compares if the variable
+    `atomic' has the pointer `old_ptr' and in that case swaps it with the
+    pointer `new_ptr'.  Returns TRUE if the old pointer was same and it was
+    swapped and FALSE if it differed and was not swapped.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_dec16.html b/docs/toolkit/manual/silcatomic-silc_atomic_dec16.html new file mode 100644 index 0000000..c3dbb72 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_dec16.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_dec16

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_dec16(SilcAtomic16 *atomic);
+
+
    +DESCRIPTION + +
    
+    Atomically decrements 16-bit integer by one.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_dec32.html b/docs/toolkit/manual/silcatomic-silc_atomic_dec32.html new file mode 100644 index 0000000..270d36b --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_dec32.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_dec32

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_dec32(SilcAtomic32 *atomic);
+
+
    +DESCRIPTION + +
    
+    Atomically decrements 32-bit integer by one.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_dec8.html b/docs/toolkit/manual/silcatomic-silc_atomic_dec8.html new file mode 100644 index 0000000..7fb9136 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_dec8.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_dec8

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_dec8(SilcAtomic8 *atomic);
+
+
    +DESCRIPTION + +
    
+    Atomically decrements 8-bit integer by one.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_get_int16.html b/docs/toolkit/manual/silcatomic-silc_atomic_get_int16.html new file mode 100644 index 0000000..a297203 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_get_int16.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_get_int16

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt32 silc_atomic_get_int16(SilcAtomic16 *atomic);
+
+
    +DESCRIPTION + +
    
+    Returns the current value of the atomic variable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_get_int32.html b/docs/toolkit/manual/silcatomic-silc_atomic_get_int32.html new file mode 100644 index 0000000..f23ba7e --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_get_int32.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_get_int32

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt32 silc_atomic_get_int32(SilcAtomic32 *atomic);
+
+
    +DESCRIPTION + +
    
+    Returns the current value of the atomic variable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_get_int8.html b/docs/toolkit/manual/silcatomic-silc_atomic_get_int8.html new file mode 100644 index 0000000..4c8bfa6 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_get_int8.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_get_int8

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt32 silc_atomic_get_int8(SilcAtomic8 *atomic);
+
+
    +DESCRIPTION + +
    
+    Returns the current value of the atomic variable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_get_pointer.html b/docs/toolkit/manual/silcatomic-silc_atomic_get_pointer.html new file mode 100644 index 0000000..8b0f0e6 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_get_pointer.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_get_pointer

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt8 silc_atomic_get_pointer(SilcAtomicPointer *atomic)
+
+
    +DESCRIPTION + +
    
+    Returns the current pointer value of the atomic variable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_inc16.html b/docs/toolkit/manual/silcatomic-silc_atomic_inc16.html new file mode 100644 index 0000000..db3a28b --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_inc16.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_inc16

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_inc16(SilcAtomic16 *atomic);
+
+
    +DESCRIPTION + +
    
+    Atomically increments 16-bit integer by one.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_inc32.html b/docs/toolkit/manual/silcatomic-silc_atomic_inc32.html new file mode 100644 index 0000000..97ddb52 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_inc32.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_inc32

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_inc32(SilcAtomic32 *atomic);
+
+
    +DESCRIPTION + +
    
+    Atomically increments 32-bit integer by one.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_inc8.html b/docs/toolkit/manual/silcatomic-silc_atomic_inc8.html new file mode 100644 index 0000000..d48356a --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_inc8.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_inc8

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_inc8(SilcAtomic8 *atomic);
+
+
    +DESCRIPTION + +
    
+    Atomically increments 8-bit integer by one.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_init16.html b/docs/toolkit/manual/silcatomic-silc_atomic_init16.html new file mode 100644 index 0000000..21b7564 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_init16.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_init16

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_init16(SilcAtomic16 *atomic, SilcUInt16 value);
+
+
    +DESCRIPTION + +
    
+    Initializes the atomic variable `atomic', and sets the `value' as its
+    inital value.  Returns FALSE on error.  To uninitialize call the
+    silc_atomic_uninit32 function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_init32.html b/docs/toolkit/manual/silcatomic-silc_atomic_init32.html new file mode 100644 index 0000000..cee60c8 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_init32.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_init32

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_init32(SilcAtomic32 *atomic, SilcUInt32 value);
+
+
    +DESCRIPTION + +
    
+    Initializes the atomic variable `atomic', and sets the `value' as its
+    inital value.  Returns FALSE on error.  To uninitialize call the
+    silc_atomic_uninit32 function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_init8.html b/docs/toolkit/manual/silcatomic-silc_atomic_init8.html new file mode 100644 index 0000000..091f6fa --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_init8.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_init8

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_init8(SilcAtomic8 *atomic, SilcUInt8 value);
+
+
    +DESCRIPTION + +
    
+    Initializes the atomic variable `atomic', and sets the `value' as its
+    inital value.  Returns FALSE on error.  To uninitialize call the
+    silc_atomic_uninit8 function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_init_pointer.html b/docs/toolkit/manual/silcatomic-silc_atomic_init_pointer.html new file mode 100644 index 0000000..1e2aefa --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_init_pointer.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_init_pointer

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_atomic_init_pointer(SilcAtomicPointer *atomic,
+                                      void *pointer);
+
+
    +DESCRIPTION + +
    
+    Initializes the atomic pointer variable `atomic', and sets the `pointer'
+    as its inital pointer.  Returns FALSE on error.  To uninitialize call
+    the silc_atomic_uninit_pointer function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_set_int16.html b/docs/toolkit/manual/silcatomic-silc_atomic_set_int16.html new file mode 100644 index 0000000..1817a71 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_set_int16.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_set_int16

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_set_int16(SilcAtomic16 *atomic, SilcUInt16 value);
+
+
    +DESCRIPTION + +
    
+    Atomically sets `value' to 16-bit integer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_set_int32.html b/docs/toolkit/manual/silcatomic-silc_atomic_set_int32.html new file mode 100644 index 0000000..f24af36 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_set_int32.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_set_int32

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_set_int32(SilcAtomic32 *atomic, SilcUInt32 value);
+
+
    +DESCRIPTION + +
    
+    Atomically sets `value' to 32-bit integer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_set_int8.html b/docs/toolkit/manual/silcatomic-silc_atomic_set_int8.html new file mode 100644 index 0000000..87a4bfe --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_set_int8.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_set_int8

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_set_int8(SilcAtomic8 *atomic, SilcUInt8 value);
+
+
    +DESCRIPTION + +
    
+    Atomically sets `value' to 8-bit integer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_set_pointer.html b/docs/toolkit/manual/silcatomic-silc_atomic_set_pointer.html new file mode 100644 index 0000000..a8bc0a1 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_set_pointer.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_set_pointer

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_set_pointer(SilcAtomicPointer *atomic, void *pointer);
+
+
    +DESCRIPTION + +
    
+    Atomically sets `pointer' to the atomic variable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_sub_int16.html b/docs/toolkit/manual/silcatomic-silc_atomic_sub_int16.html new file mode 100644 index 0000000..4fe21bf --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_sub_int16.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_sub_int16

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt16 silc_atomic_sub_int16(SilcAtomic16 *atomic, SilcInt16 value);
+
+
    +DESCRIPTION + +
    
+    Atomically subtracts `value' from 16-bit integer.  Returns the value
+    after subtraction.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_sub_int32.html b/docs/toolkit/manual/silcatomic-silc_atomic_sub_int32.html new file mode 100644 index 0000000..e217dd6 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_sub_int32.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_sub_int32

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt32 silc_atomic_sub_int32(SilcAtomic32 *atomic, SilcInt32 value);
+
+
    +DESCRIPTION + +
    
+    Atomically subtracts `value' from 32-bit integer.  Returns the value
+    after subtraction.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_sub_int8.html b/docs/toolkit/manual/silcatomic-silc_atomic_sub_int8.html new file mode 100644 index 0000000..7e9fb47 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_sub_int8.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_sub_int8

    + + +SYNOPSIS + +
    
+    static inline
+    SilcUInt8 silc_atomic_sub_int8(SilcAtomic8 *atomic, SilcInt8 value);
+
+
    +DESCRIPTION + +
    
+    Atomically subtracts `value' from 8-bit integer.  Returns the value
+    after subtraction.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_uninit16.html b/docs/toolkit/manual/silcatomic-silc_atomic_uninit16.html new file mode 100644 index 0000000..132cf01 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_uninit16.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_uninit16

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_uninit16(SilcAtomic16 *atomic);
+
+
    +DESCRIPTION + +
    
+    Uninitializes the atomic variable `atomic'.  This should alwyas be
+    called after the atomic variable is not used anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_uninit32.html b/docs/toolkit/manual/silcatomic-silc_atomic_uninit32.html new file mode 100644 index 0000000..7e84f12 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_uninit32.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_uninit32

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_uninit32(SilcAtomic32 *atomic);
+
+
    +DESCRIPTION + +
    
+    Uninitializes the atomic variable `atomic'.  This should alwyas be
+    called after the atomic variable is not used anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_uninit8.html b/docs/toolkit/manual/silcatomic-silc_atomic_uninit8.html new file mode 100644 index 0000000..59ad197 --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_uninit8.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_uninit8

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_uninit8(SilcAtomic8 *atomic);
+
+
    +DESCRIPTION + +
    
+    Uninitializes the atomic variable `atomic'.  This should alwyas be
+    called after the atomic variable is not used anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic-silc_atomic_uninit_pointer.html b/docs/toolkit/manual/silcatomic-silc_atomic_uninit_pointer.html new file mode 100644 index 0000000..e7fa7ce --- /dev/null +++ b/docs/toolkit/manual/silcatomic-silc_atomic_uninit_pointer.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_atomic_uninit_pointer

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_atomic_uninit_pointer(SilcAtomicPointer *atomic);
+
+
    +DESCRIPTION + +
    
+    Uninitializes the atomic variable `atomic'.  This should alwyas be
+    called after the atomic variable is not used anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Atomic Operations Interface
    +SilcAtomic32
    +SilcAtomic16
    +SilcAtomic8
    +SilcAtomicPointer
    +silc_atomic_init32
    +silc_atomic_init16
    +silc_atomic_init8
    +silc_atomic_init_pointer
    +silc_atomic_uninit32
    +silc_atomic_uninit16
    +silc_atomic_uninit8
    +silc_atomic_uninit_pointer
    +silc_atomic_set_int32
    +silc_atomic_set_int16
    +silc_atomic_set_int8
    +silc_atomic_set_pointer
    +silc_atomic_get_int32
    +silc_atomic_get_int16
    +silc_atomic_get_int8
    +silc_atomic_get_pointer
    +silc_atomic_add_int32
    +silc_atomic_add_int16
    +silc_atomic_add_int8
    +silc_atomic_sub_int32
    +silc_atomic_sub_int16
    +silc_atomic_sub_int8
    +silc_atomic_inc32
    +silc_atomic_inc16
    +silc_atomic_inc8
    +silc_atomic_dec32
    +silc_atomic_dec16
    +silc_atomic_dec8
    +silc_atomic_cas32
    +silc_atomic_cas16
    +silc_atomic_cas8
    +silc_atomic_cas_pointer
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic.html b/docs/toolkit/manual/silcatomic.html new file mode 100644 index 0000000..e31a32d --- /dev/null +++ b/docs/toolkit/manual/silcatomic.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcatomic.html + + + + +
    + +SILC Atomic Operations Interface
    Header: silcatomic.h

    + + +DESCRIPTION + +
    
+ SILC Atomic operations interface provides utility functions to perform
+ simple operations with integers atomically.  This enables fast integer
+ additions and subtractions safely in multithreaded environment.  It is
+ especially suited for reference counters and similar and is much faster
+ than using locking.  This interface supports 8, 16 and 32 bit integers
+ and 32 or 64 bit pointers.
+
+ On some platforms this interface actually use mutual exclusion lock
+ instead of true atomic operations, leading into some performace penalty.
+ Also on some platforms the 8 and 16 bit integers are actually 32 bit
+ integers.
+
+ Fast operations are supported on: x86, x86_64, ia64, PPC
+
+
  • SilcAtomic32 +
  • SilcAtomic16 +
  • SilcAtomic8 +
  • SilcAtomicPointer +
  • silc_atomic_init32 +
  • silc_atomic_init16 +
  • silc_atomic_init8 +
  • silc_atomic_init_pointer +
  • silc_atomic_uninit32 +
  • silc_atomic_uninit16 +
  • silc_atomic_uninit8 +
  • silc_atomic_uninit_pointer +
  • silc_atomic_set_int32 +
  • silc_atomic_set_int16 +
  • silc_atomic_set_int8 +
  • silc_atomic_set_pointer +
  • silc_atomic_get_int32 +
  • silc_atomic_get_int16 +
  • silc_atomic_get_int8 +
  • silc_atomic_get_pointer +
  • silc_atomic_add_int32 +
  • silc_atomic_add_int16 +
  • silc_atomic_add_int8 +
  • silc_atomic_sub_int32 +
  • silc_atomic_sub_int16 +
  • silc_atomic_sub_int8 +
  • silc_atomic_inc32 +
  • silc_atomic_inc16 +
  • silc_atomic_inc8 +
  • silc_atomic_dec32 +
  • silc_atomic_dec16 +
  • silc_atomic_dec8 +
  • silc_atomic_cas32 +
  • silc_atomic_cas16 +
  • silc_atomic_cas8 +
  • silc_atomic_cas_pointer + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcatomic.xref b/docs/toolkit/manual/silcatomic.xref new file mode 100644 index 0000000..1c87ef0 --- /dev/null +++ b/docs/toolkit/manual/silcatomic.xref @@ -0,0 +1,43 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcatomic.h" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 0 + "SILC Atomic Operations Interface" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 1 + "SilcAtomic32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 5 + "SilcAtomic16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 5 + "SilcAtomic8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 5 + "SilcAtomicPointer" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 5 + "silc_atomic_init32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_init16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_init8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_init_pointer" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_uninit32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_uninit16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_uninit8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_uninit_pointer" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_set_int32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_set_int16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_set_int8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_set_pointer" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_get_int32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_get_int16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_get_int8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_get_pointer" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_add_int32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_add_int16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_add_int8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_sub_int32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_sub_int16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_sub_int8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_inc32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_inc16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_inc8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_dec32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_dec16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_dec8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_cas32" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_cas16" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_cas8" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + "silc_atomic_cas_pointer" "/home/priikone/silc1/doc/toolkit/silcatomic.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcattrs-SilcAttribute.html b/docs/toolkit/manual/silcattrs-SilcAttribute.html new file mode 100644 index 0000000..7066b78 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttribute.html @@ -0,0 +1,262 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAttribute

    + + +NAME + +
    
+    typedef SilcUInt8 SilcAttribute;
+
+
    +DESCRIPTION + +
    
+    The SilcAttribute type definition and the attributes. The attributes
+    listed here are the official attributes defined in the internet
+    draft.  They define the contents of the attribute payload and the
+    type of the attribute.
+
+
    +SOURCE + +
        typedef SilcUInt8 SilcAttribute;
+    
+    /* All defined attributes.  See the specs for detailed information.  The
+       comment is the structure or data type that must be used with the
+       silc_attribute_get_object function to fetch parsed attribute. */
+    #define SILC_ATTRIBUTE_NONE                   0
+    #define SILC_ATTRIBUTE_USER_INFO              1   /* SilcVCard */
+    #define SILC_ATTRIBUTE_SERVICE                2   /* SilcAttributeObjService */
+    #define SILC_ATTRIBUTE_STATUS_MOOD            3   /* SilcAttributeMood */
+    #define SILC_ATTRIBUTE_STATUS_FREETEXT        4   /* char * (UTF-8 string) */
+    #define SILC_ATTRIBUTE_STATUS_MESSAGE         5   /* SilcMime */
+    #define SILC_ATTRIBUTE_PREFERRED_LANGUAGE     6   /* char * (UTF-8 string) */
+    #define SILC_ATTRIBUTE_PREFERRED_CONTACT      7   /* SilcAttributeContact */
+    #define SILC_ATTRIBUTE_TIMEZONE               8   /* char * (UTF-8 string) */
+    #define SILC_ATTRIBUTE_GEOLOCATION            9   /* SilcAttributeObjGeo */
+    #define SILC_ATTRIBUTE_DEVICE_INFO            10  /* SilcAttributeObjDevice */
+    #define SILC_ATTRIBUTE_EXTENSION              11  /* SilcMime */
+    #define SILC_ATTRIBUTE_USER_PUBLIC_KEY        12  /* SilcAttributeObjPk */
+    #define SILC_ATTRIBUTE_SERVER_PUBLIC_KEY      13  /* SilcAttributeObjPk */
+    #define SILC_ATTRIBUTE_USER_DIGITAL_SIGNATURE 14  /* SilcAttributeObjPk */
+    #define SILC_ATTRIBUTE_SERVER_DIGITAL_SIGNATURE 15 /* SilcAttributeObjPk */
+    #define SILC_ATTRIBUTE_USER_ICON              16  /* SilcMime */
+    #define SILC_ATTRIBUTE_PHONE_NUMBER           17  /* SilcAttributeObjPN */
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeContact.html b/docs/toolkit/manual/silcattrs-SilcAttributeContact.html new file mode 100644 index 0000000..5ed8063 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeContact.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAttributeContact

    + + +NAME + +
    
+    typedef enum { ... } SilcAttributeContact;
+
+
    +DESCRIPTION + +
    
+    The defined preferred contact methods defined by the specification.
+    This is bit mask.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_ATTRIBUTE_CONTACT_NONE    = 0x00000000,    /* no specific method */
+      SILC_ATTRIBUTE_CONTACT_EMAIL   = 0x00000001,    /* email preferred */
+      SILC_ATTRIBUTE_CONTACT_CALL    = 0x00000002,    /* phone call preferred */
+      SILC_ATTRIBUTE_CONTACT_PAGE    = 0x00000004,    /* "paging" preferred */
+      SILC_ATTRIBUTE_CONTACT_SMS     = 0x00000008,    /* SMS preferred */
+      SILC_ATTRIBUTE_CONTACT_MMS     = 0x00000010,    /* MMS preferred */
+      SILC_ATTRIBUTE_CONTACT_CHAT    = 0x00000020,    /* chatting preferred */
+      SILC_ATTRIBUTE_CONTACT_VIDEO   = 0x00000040,    /* video conferencing */
+    } SilcAttributeContact;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeDevice.html b/docs/toolkit/manual/silcattrs-SilcAttributeDevice.html new file mode 100644 index 0000000..64cf2de --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeDevice.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAttributeDevice

    + + +NAME + +
    
+    typedef enum { ... } SilcAttributeDevice;
+
+
    +DESCRIPTION + +
    
+    The defined device types defined by the specification.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_ATTRIBUTE_DEVICE_COMPUTER      = 0,        /* device is computer */
+      SILC_ATTRIBUTE_DEVICE_MOBILE_PHONE  = 1,        /* device is mobile phone */
+      SILC_ATTRIBUTE_DEVICE_PDA           = 2,        /* device is PDA */
+      SILC_ATTRIBUTE_DEVICE_TERMINAL      = 3,        /* device is terminal */
+    } SilcAttributeDevice;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeFlags.html b/docs/toolkit/manual/silcattrs-SilcAttributeFlags.html new file mode 100644 index 0000000..f335c0f --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeFlags.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAttributeFlags

    + + +NAME + +
    
+    typedef SilcUInt8 SilcAttributeFlags;
+
+
    +DESCRIPTION + +
    
+    Attribute Payload flags defined by the specification.
+
+
    +SOURCE + +
        typedef SilcUInt8 SilcAttributeFlags;
+    
+    /* All defined flags */
+    #define SILC_ATTRIBUTE_FLAG_NONE          0x00    /* No flags */
+    #define SILC_ATTRIBUTE_FLAG_INVALID       0x01    /* Invalid attribute */
+    #define SILC_ATTRIBUTE_FLAG_VALID         0x02    /* Valid attribute */
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeMood.html b/docs/toolkit/manual/silcattrs-SilcAttributeMood.html new file mode 100644 index 0000000..09ac23a --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeMood.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAttributeMood

    + + +NAME + +
    
+    typedef enum { ... } SilcAttributeMood;
+
+
    +DESCRIPTION + +
    
+    The user mood indicators defined by the specification.  This is
+    bit mask.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_ATTRIBUTE_MOOD_NORMAL      = 0x00000000,   /* normal mood */
+      SILC_ATTRIBUTE_MOOD_HAPPY       = 0x00000001,   /* user feel happy */
+      SILC_ATTRIBUTE_MOOD_SAD         = 0x00000002,   /* user feel sad */
+      SILC_ATTRIBUTE_MOOD_ANGRY       = 0x00000004,   /* user feel angry */
+      SILC_ATTRIBUTE_MOOD_JEALOUS     = 0x00000008,   /* user feel jealous */
+      SILC_ATTRIBUTE_MOOD_ASHAMED     = 0x00000010,   /* user feel ashamed */
+      SILC_ATTRIBUTE_MOOD_INVINCIBLE  = 0x00000020,   /* user feel invincible */
+      SILC_ATTRIBUTE_MOOD_INLOVE      = 0x00000040,   /* user feel in love */
+      SILC_ATTRIBUTE_MOOD_SLEEPY      = 0x00000080,   /* user feel sleepy */
+      SILC_ATTRIBUTE_MOOD_BORED       = 0x00000100,   /* user feel bored */
+      SILC_ATTRIBUTE_MOOD_EXCITED     = 0x00000200,   /* user feel exited */
+      SILC_ATTRIBUTE_MOOD_ANXIOUS     = 0x00000400,   /* user feel anxious */
+    } SilcAttributeMood;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeObjDevice.html b/docs/toolkit/manual/silcattrs-SilcAttributeObjDevice.html new file mode 100644 index 0000000..539b0f6 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeObjDevice.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAttributeObjDevice

    + + +NAME + +
    
+    typedef struct { ... } SilcAttributeObjDevice;
+
+
    +DESCRIPTION + +
    
+    SILC_ATTRIBUTE_DEVICE_INFO type object.  The caller must free the
+    strings inside the structure.
+
+
    +SOURCE + +
        typedef struct SilcAttributeObjDeviceStruct {
+      SilcAttributeDevice type;     /* device type */
+      char *manufacturer;           /* manufacturer of the device */
+      char *version;                /* device version string */
+      char *model;                  /* device model string */
+      char *language;               /* device language (ISO 639-2/T) */
+    } SilcAttributeObjDevice;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeObjGeo.html b/docs/toolkit/manual/silcattrs-SilcAttributeObjGeo.html new file mode 100644 index 0000000..24e724d --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeObjGeo.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAttributeObjGeo

    + + +NAME + +
    
+    typedef struct { ... } SilcAttributeObjGeo;
+
+
    +DESCRIPTION + +
    
+    SILC_ATTRIBUTE_GEOLOCATION type object.  The caller must free the
+    strings inside the structure.
+
+
    +SOURCE + +
        typedef struct SilcAttributeObjGeoStruct {
+      char *longitude;              /* Longitude */
+      char *latitude;               /* Latitude */
+      char *altitude;               /* Altitude */
+      char *accuracy;               /* Accuracy in meters */
+    } SilcAttributeObjGeo;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeObjPN.html b/docs/toolkit/manual/silcattrs-SilcAttributeObjPN.html new file mode 100644 index 0000000..6963a17 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeObjPN.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAttributeObjPN

    + + +NAME + +
    
+    typedef struct { ... } SilcAttributeObjPN;
+
+
    +DESCRIPTION + +
    
+    SILC_ATTRIBUTE_PHONE_NUMBER type object.  The caller must free the
+    phone number string inside the structure.
+
+
    +SOURCE + +
        typedef struct SilcAttributeObjPNStruct {
+      SilcAttributePNFormat format; /* Phone number format */
+      char *number;                 /* Phone number */
+    } SilcAttributeObjPN;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeObjPk.html b/docs/toolkit/manual/silcattrs-SilcAttributeObjPk.html new file mode 100644 index 0000000..211fcc2 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeObjPk.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAttributeObjPk

    + + +NAME + +
    
+    typedef struct { ... } SilcAttributeObjPk;
+
+
    +DESCRIPTION + +
    
+    Data type for public key, certificate or digital signatures.  The
+    caller must free the data inside the structure.  The 'type' is one
+    of following: "silc-rsa", "silc-dss, "ssh-rsa", "ssh-dss",
+    "pgp-sign-rsa", "pgp-sign-dss", "x509v3-sign-rsa", "x509v3-sign-dss".
+    The 'type' is NULL when this structure includes a digital signature.
+
+    In SILC, at least the "silc-rsa" must be supported.  In this case
+    the key is normal SILC Public key.  To verify a signature with the
+    SILC Public key, construct the signature data with the
+    silc_attribute_get_verify_data and verify the signature with
+    for example silc_pkcs_verify_with_hash function.  The public key
+    to the verification is the `data' and `data_len', and can be decoded
+    with silc_pkcs_public_key_decode function.
+
+
    +SOURCE + +
        typedef struct SilcAttributeObjPkStruct {
+      char *type;                   /* public key/certificate type, NULL
+                                       when contains digital signature. */
+      unsigned char *data;          /* public key/cert/signature data. The
+                                       encoding depends of the `type'. */
+      SilcUInt32 data_len;          /* data length */
+    } SilcAttributeObjPk;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributeObjService.html b/docs/toolkit/manual/silcattrs-SilcAttributeObjService.html new file mode 100644 index 0000000..c78b82f --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributeObjService.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAttributeObjService

    + + +NAME + +
    
+    typedef struct { ... } SilcAttributeObjService;
+
+
    +DESCRIPTION + +
    
+    SILC_ATTRIBUTE_SERVICE type object structure.
+
+
    +SOURCE + +
        typedef struct SilcAttributeObjServiceStruct {
+      SilcUInt32 port;              /* IANA specified service port */
+      SilcUInt32 idle;              /* Idle time in the service */
+      char signon[64];              /* Signon date and time (UTC) */
+      char address[256];            /* service address */
+      SilcBool status;              /* online status (TRUE present in service) */
+    } SilcAttributeObjService;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributePNFormat.html b/docs/toolkit/manual/silcattrs-SilcAttributePNFormat.html new file mode 100644 index 0000000..b2c184d --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributePNFormat.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAttributePNFormat

    + + +NAME + +
    
+    typedef enum { ... } SilcAttributePNFormat;
+
+
    +DESCRIPTION + +
    
+    The defined phone number formats.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_ATTRIBUTE_NUMBER_ITU_E164        = 0,      /* ITU E.164 */
+      SILC_ATTRIBUTE_NUMBER_ITU_E123        = 1,      /* ITU E.123 */
+      SILC_ATTRIBUTE_NUMBER_ENUM            = 2,      /* ENUM, RFC 3761 */
+    } SilcAttributePNFormat;
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-SilcAttributePayload.html b/docs/toolkit/manual/silcattrs-SilcAttributePayload.html new file mode 100644 index 0000000..6e5ddf3 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-SilcAttributePayload.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAttributePayload

    + + +NAME + +
    
+    typedef struct SilcAttributePayloadStruct *SilcAttributePayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Attribute Payload and is allocated
+    by silc_attribute_payload_parse and given as attribute usually to
+    all silc_attribute_payload_* functions.  It is freed by the
+    silc_attribute_payload_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_get_attribute.html b/docs/toolkit/manual/silcattrs-silc_attribute_get_attribute.html new file mode 100644 index 0000000..1f63425 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_get_attribute.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_get_attribute

    + + +SYNOPSIS + +
    
+    SilcAttribute silc_attribute_get_attribute(SilcAttributePayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the attribute type from the payload indicated by `payload'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_get_data.html b/docs/toolkit/manual/silcattrs-silc_attribute_get_data.html new file mode 100644 index 0000000..9f01942 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_get_data.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_get_data

    + + +SYNOPSIS + +
    
+    const unsigned char *
+    silc_attribute_get_data(SilcAttributePayload payload,
+                            SilcUInt32 *data_len);
+
+
    +DESCRIPTION + +
    
+    Returns the attribute data from the payload indicated by the `payload'
+    The caller must not free the returned data pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_get_flags.html b/docs/toolkit/manual/silcattrs-silc_attribute_get_flags.html new file mode 100644 index 0000000..6caf2a0 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_get_flags.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_get_flags

    + + +SYNOPSIS + +
    
+    SilcAttributeFlags
+    silc_attribute_get_flags(SilcAttributePayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the attribute flags from the payload indicated by `payload'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_get_object.html b/docs/toolkit/manual/silcattrs-silc_attribute_get_object.html new file mode 100644 index 0000000..6aa6133 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_get_object.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_get_object

    + + +SYNOPSIS + +
    
+    SilcBool silc_attribute_get_object(SilcAttributePayload payload,
+                                       void *object,
+                                       SilcUInt32 object_size);
+
+
    +DESCRIPTION + +
    
+    Returns the already parsed attribute object from the payload
+    indicated by `payload'.  Copies the data into the `object' which
+    must be sent as argument (and must be of correct type and size).
+    The `object_size' indicates the size of the `*object' sent.
+    Returns TRUE if the `attribute' attribute was found and FALSE
+    if such attribute is not present in the `payload', or the `object_size'
+    is not sufficient.  See the definition of SilcAttribute for the
+    list of attributes and the required object types for attributes.
+    You can use silc_attribute_get_attribute to get the SilcAttribute
+    type from the `payload'.
+
+
    +EXAMPLE + +
    
+    SilcAttributeObjDevice dev;
+
+    ...
+    case SILC_ATTRIBUTE_DEVICE_INFO:
+    memset(&dev, 0, sizeof(dev));
+    if (!silc_attribute_get_object(payload, (void *)&dev, sizeof(dev)))
+      error();
+
+    case SILC_ATTRIBUTE_USER_ICON:
+    mime = silc_mime_alloc();
+    if (!silc_attribute_get_object(payload, (void *)mime, sizeof(*mime)))
+      error();
+    ...
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_get_verify_data.html b/docs/toolkit/manual/silcattrs-silc_attribute_get_verify_data.html new file mode 100644 index 0000000..fddad97 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_get_verify_data.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_get_verify_data

    + + +SYNOPSIS + +
    
+    unsigned char *
+    silc_attribute_get_verify_data(SilcDList attrs,
+                                   SilcBool server_verification,
+                                   SilcUInt32 *data_len);
+
+
    +DESCRIPTION + +
    
+    Constructs the data to be verified with the sender's digital
+    signature and sender's public key.  This allocates the data from
+    the list of attribute payloads and returns the buffer.  The caller
+    must free it.  If `server_verification' is FALSE then data is
+    constructed for user's digital signature verification, if it is
+    TRUE then it is constructed for server's digital signature
+    verification.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_payload_alloc.html b/docs/toolkit/manual/silcattrs-silc_attribute_payload_alloc.html new file mode 100644 index 0000000..5d34c55 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_payload_alloc.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_payload_alloc

    + + +SYNOPSIS + +
    
+    SilcAttributesPayload
+    silc_attribute_payload_alloc(SilcAttribute attribute,
+                                 SilcAttributeFlags flags,
+                                 void *object,
+                                 SilcUInt32 object_size);
+
+
    +DESCRIPTION + +
    
+    Allocates and encodes the attribute indicated by `attribute' and
+    returns pointer to the attribute.
+
+    The `object' must always be the same data type as defined with
+    SilcAttribute (see the comments) for all attributes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_payload_encode.html b/docs/toolkit/manual/silcattrs-silc_attribute_payload_encode.html new file mode 100644 index 0000000..9b566e1 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_payload_encode.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_attribute_payload_encode(SilcBuffer attrs,
+                                             SilcAttribute attribute,
+                                             SilcAttributeFlags flags,
+                                             void *object,
+                                             SilcUInt32 object_size);
+
+
    +DESCRIPTION + +
    
+    Encodes one attribute payload into the `attrs' buffer and returns
+    pointer to the buffer, which may be different in case the buffer
+    was reallocated.  If `attrs' is NULL for first attribute this
+    allocates the buffer and returns it.  This can be called multiple
+    times to add multiple attributes to the `attrs' buffer.  The `flags'
+    indicates the validity of the added attribute.  Returns NULL on
+    error.
+
+    The `object' must always be the same data type as defined with
+    SilcAttribute (see the comments) for all attributes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_payload_encode_data.html b/docs/toolkit/manual/silcattrs-silc_attribute_payload_encode_data.html new file mode 100644 index 0000000..afa51cc --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_payload_encode_data.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_payload_encode_data

    + + +SYNOPSIS + +
    
+    SilcBuffer
+    silc_attribute_payload_encode_data(SilcBuffer attrs,
+                                       SilcAttribute attribute,
+                                       SilcAttributeFlags flags,
+                                       const unsigned char *data,
+                                       SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Same function as silc_attribute_payload_encode except the attribute
+    is already encoded into `data' of `data_len' bytes in length.
+    Encodes the attribute into the `attrs' buffer and returns pointer
+    to the buffer, which may be different in case the buffer was
+    reallocated.  If `attrs' is NULL for first attribute this allocates
+    the buffer and returns it.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_payload_free.html b/docs/toolkit/manual/silcattrs-silc_attribute_payload_free.html new file mode 100644 index 0000000..c8ffb75 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_payload_free.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_payload_free

    + + +SYNOPSIS + +
    
+    void silc_attribute_payload_free(SilcAttributePayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Attribute Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_payload_list_free.html b/docs/toolkit/manual/silcattrs-silc_attribute_payload_list_free.html new file mode 100644 index 0000000..e703a1b --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_payload_list_free.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_payload_list_free

    + + +SYNOPSIS + +
    
+    void silc_attribute_payload_list_free(SilcDList list);
+
+
    +DESCRIPTION + +
    
+    Frees list of Attribute Payloads and all data in them.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs-silc_attribute_payload_parse.html b/docs/toolkit/manual/silcattrs-silc_attribute_payload_parse.html new file mode 100644 index 0000000..4f9c182 --- /dev/null +++ b/docs/toolkit/manual/silcattrs-silc_attribute_payload_parse.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_attribute_payload_parse

    + + +SYNOPSIS + +
    
+    SilcDList
+    silc_attribute_payload_parse(const unsigned char *payload,
+                                 SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parses list of Attribute payloads returning list of payloads.
+    One entry in the returned list is SilcAttributesPayload.  You
+    can produce such a list with silc_attribute_payload_encode
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Attribute Interface
    +SilcAttributePayload
    +SilcAttribute
    +SilcAttributeFlags
    +SilcAttributeMood
    +SilcAttributeContact
    +SilcAttributeDevice
    +SilcAttributePNFormat
    +silc_attribute_payload_alloc
    +silc_attribute_payload_parse
    +silc_attribute_payload_encode
    +silc_attribute_payload_encode_data
    +silc_attribute_payload_free
    +silc_attribute_payload_list_free
    +silc_attribute_get_attribute
    +silc_attribute_get_flags
    +silc_attribute_get_data
    +silc_attribute_get_verify_data
    +SilcAttributeObjService
    +SilcAttributeObjGeo
    +SilcAttributeObjDevice
    +SilcAttributeObjPk
    +SilcAttributeObjPN
    +silc_attribute_get_object
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs.html b/docs/toolkit/manual/silcattrs.html new file mode 100644 index 0000000..aa9a54d --- /dev/null +++ b/docs/toolkit/manual/silcattrs.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcattrs.html + + + + +
    + +SILC Attribute Interface
    Header: silcattrs.h

    + + +DESCRIPTION + +
    
+ Implementation of the Attribute Payload that may be used to send and
+ retrieve user online precense information in the SILC network.  This
+ implements the draft-riikonen-precense-attrs draft.
+
+
  • SilcAttributePayload +
  • SilcAttribute +
  • SilcAttributeFlags +
  • SilcAttributeMood +
  • SilcAttributeContact +
  • SilcAttributeDevice +
  • SilcAttributePNFormat +
  • silc_attribute_payload_alloc +
  • silc_attribute_payload_parse +
  • silc_attribute_payload_encode +
  • silc_attribute_payload_encode_data +
  • silc_attribute_payload_free +
  • silc_attribute_payload_list_free +
  • silc_attribute_get_attribute +
  • silc_attribute_get_flags +
  • silc_attribute_get_data +
  • silc_attribute_get_verify_data +
  • SilcAttributeObjService +
  • SilcAttributeObjGeo +
  • SilcAttributeObjDevice +
  • SilcAttributeObjPk +
  • SilcAttributeObjPN +
  • silc_attribute_get_object + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcattrs.xref b/docs/toolkit/manual/silcattrs.xref new file mode 100644 index 0000000..def69a0 --- /dev/null +++ b/docs/toolkit/manual/silcattrs.xref @@ -0,0 +1,30 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcattrs.h" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 0 + "SILC Attribute Interface" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 1 + "SilcAttributePayload" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 5 + "SilcAttribute" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 8 + "SilcAttributeFlags" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 8 + "SilcAttributeMood" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 8 + "SilcAttributeContact" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 8 + "SilcAttributeDevice" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 8 + "SilcAttributePNFormat" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 8 + "silc_attribute_payload_alloc" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_payload_parse" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_payload_encode" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_payload_encode_data" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_payload_free" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_payload_list_free" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_get_attribute" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_get_flags" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_get_data" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "silc_attribute_get_verify_data" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + "SilcAttributeObjService" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 5 + "SilcAttributeObjGeo" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 5 + "SilcAttributeObjDevice" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 5 + "SilcAttributeObjPk" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 5 + "SilcAttributeObjPN" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 5 + "silc_attribute_get_object" "/home/priikone/silc1/doc/toolkit/silcattrs.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcauth-SilcAuthMethod.html b/docs/toolkit/manual/silcauth-SilcAuthMethod.html new file mode 100644 index 0000000..392cf60 --- /dev/null +++ b/docs/toolkit/manual/silcauth-SilcAuthMethod.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcAuthMethod

    + + +NAME + +
    
+    typedef SilcUInt16 SilcAuthMethod;
+
+
    +DESCRIPTION + +
    
+    Authentication method type definition, the authentication methods
+    and the authentication status'.  The status defines are used by
+    all authentication protocols in the SILC.
+
+
    +SOURCE + +
        typedef SilcUInt16 SilcAuthMethod;
+    
+    #define SILC_AUTH_NONE        0            /* No authentication */
+    #define SILC_AUTH_PASSWORD    1            /* Passphrase authentication */
+    #define SILC_AUTH_PUBLIC_KEY  2            /* Public key authentication */    
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-SilcAuthPayload.html b/docs/toolkit/manual/silcauth-SilcAuthPayload.html new file mode 100644 index 0000000..57a03ae --- /dev/null +++ b/docs/toolkit/manual/silcauth-SilcAuthPayload.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcAuthPayload

    + + +NAME + +
    
+    typedef struct SilcAuthPayloadStruct *SilcAuthPayload;
+
+
+
    +DESCRIPTION + +
    
+    This context is the actual Authentication Payload and is allocated
+    by silc_auth_payload_parse and given as argument usually to all
+    silc_auth_payload_* functions.  It is freed by silc_auth_payload_free
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-SilcKeyAgreementPayload.html b/docs/toolkit/manual/silcauth-SilcKeyAgreementPayload.html new file mode 100644 index 0000000..b7b86ac --- /dev/null +++ b/docs/toolkit/manual/silcauth-SilcKeyAgreementPayload.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcKeyAgreementPayload

    + + +NAME + +
    
+    typedef struct SilcKeyAgreementPayloadStruct *SilcKeyAgreementPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Key Agreement Payload and is allocated
+    by silc_key_agreement_payload_parse and given as argument usually to all
+    silc_key_agreement_* functions.  It is freed by the function
+    silc_key_agreement_payload_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_get_data.html b/docs/toolkit/manual/silcauth-silc_auth_get_data.html new file mode 100644 index 0000000..9604880 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_get_data.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_get_data

    + + +SYNOPSIS + +
    
+    unsigned char *silc_auth_get_data(SilcAuthPayload payload,
+                                      SilcUInt32 *auth_len);
+
+
    +DESCRIPTION + +
    
+    Get the authentication data. The caller must not free the data.  If
+    the authentication method is passphrase, then the returned string
+    is UTF-8 encoded passphrase.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_get_method.html b/docs/toolkit/manual/silcauth-silc_auth_get_method.html new file mode 100644 index 0000000..2e9d4fb --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_get_method.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_get_method

    + + +SYNOPSIS + +
    
+    SilcAuthMethod silc_auth_get_method(SilcAuthPayload payload);
+
+
    +DESCRIPTION + +
    
+    Get authentication method.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_get_public_data.html b/docs/toolkit/manual/silcauth-silc_auth_get_public_data.html new file mode 100644 index 0000000..bde8452 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_get_public_data.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_get_public_data

    + + +SYNOPSIS + +
    
+    unsigned char *silc_auth_get_public_data(SilcAuthPayload payload,
+                                             SilcUInt32 *pubdata_len);
+
+
    +DESCRIPTION + +
    
+    Returns the public data (usually random data) from the payload.
+    Caller must not free the returned data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_payload_encode.html b/docs/toolkit/manual/silcauth-silc_auth_payload_encode.html new file mode 100644 index 0000000..30b851e --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_payload_encode.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_auth_payload_encode(SilcAuthMethod method,
+                                        const unsigned char *random_data,
+                                        SilcUInt16 random_len,
+                                        const unsigned char *auth_data,
+                                        SilcUInt16 auth_len);
+
+
    +DESCRIPTION + +
    
+    Encodes authentication payload into buffer and returns it.
+    The `random_data' is provided only if doing public key authentication.
+    The `auth_data' is the actual authentication data.  If the
+    `method' is SILC_AUTH_PASSWORD the passphase in `auth_data' sent as
+    argument SHOULD be UTF-8 encoded, if not library will attempt to
+    encode it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_payload_free.html b/docs/toolkit/manual/silcauth-silc_auth_payload_free.html new file mode 100644 index 0000000..b1eaede --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_payload_free.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_payload_free

    + + +SYNOPSIS + +
    
+    void silc_auth_payload_free(SilcAuthPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees authentication payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_payload_parse.html b/docs/toolkit/manual/silcauth-silc_auth_payload_parse.html new file mode 100644 index 0000000..a8c70b3 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_payload_parse.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_payload_parse

    + + +SYNOPSIS + +
    
+    SilcAuthPayload silc_auth_payload_parse(const unsigned char *data,
+                                            SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Parses and returns Authentication Payload.  The `data' and the
+    `data_len' are the raw payload buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate.html b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate.html new file mode 100644 index 0000000..4aeabf2 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_public_key_auth_generate

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_auth_public_key_auth_generate(SilcPublicKey public_key,
+                                                  SilcPrivateKey private_key,
+                                                  SilcRng rng,
+                                                  SilcHash hash,
+                                                  const void *id,
+                                                  SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Generates Authentication Payload with authentication data. This is used
+    to do public key based authentication. This generates the random data
+    and the actual authentication data. Returns NULL on error and the
+    encoded Authentication Payload on success.
+
+    The `private_key' is used to sign the payload.  The `public_key', the
+    and the `id' is encoded in the payload and signed.  If the `rng' is
+    NULL then global RNG is used, if non-NULL then `rng' is used as
+    random number generator.  Also random number is encoded in the
+    payload before signing it with `private_key'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate_wpub.html b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate_wpub.html new file mode 100644 index 0000000..c71ad1b --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_generate_wpub.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_public_key_auth_generate_wpub

    + + +SYNOPSIS + +
    
+    SilcBuffer
+    silc_auth_public_key_auth_generate_wpub(SilcPublicKey public_key,
+                                            SilcPrivateKey private_key,
+                                            const unsigned char *pubdata,
+                                            SilcUInt32 pubdata_len,
+                                            SilcHash hash,
+                                            const void *id,
+                                            SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Same as silc_auth_public_key_auth_generate but takes the public data
+    (usually random data) as argument.  This function can be used when
+    the public data must be something else than purely random or its
+    structure mut be set before signing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify.html b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify.html new file mode 100644 index 0000000..c8e2ecb --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_public_key_auth_verify

    + + +SYNOPSIS + +
    
+    SilcBool silc_auth_public_key_auth_verify(SilcAuthPayload payload,
+                                          SilcPublicKey public_key,
+                                          SilcHash hash,
+                                          const void *id, SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Verifies the authentication data. Returns TRUE if authentication was
+    successful.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify_data.html b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify_data.html new file mode 100644 index 0000000..f159759 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_public_key_auth_verify_data.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_public_key_auth_verify_data

    + + +SYNOPSIS + +
    
+    SilcBool silc_auth_public_key_auth_verify_data(const unsigned char *payload,
+                                               SilcUInt32 payload_len,
+                                               SilcPublicKey public_key,
+                                               SilcHash hash,
+                                               const void *id,
+                                               SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Same as silc_auth_public_key_auth_verify but the payload has not
+    been parsed yet.  This will parse it.  Returns TRUE if authentication
+    was successful.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_verify.html b/docs/toolkit/manual/silcauth-silc_auth_verify.html new file mode 100644 index 0000000..5a54b6b --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_verify.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_verify

    + + +SYNOPSIS + +
    
+    SilcBool silc_auth_verify(SilcAuthPayload payload,
+                          SilcAuthMethod auth_method,
+                          const void *auth_data, SilcUInt32 auth_data_len,
+                          SilcHash hash, const void *id, SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Verifies the authentication data directly from the Authentication
+    Payload. Supports all authentication methods. If the authentication
+    method is passphrase based then the `auth_data' and `auth_data_len'
+    are the passphrase and its length.  The passphrase MUST be UTF-8
+    encoded.  If the method is public key authentication then the
+    `auth_data' is the SilcPublicKey and the `auth_data_len' is ignored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_auth_verify_data.html b/docs/toolkit/manual/silcauth-silc_auth_verify_data.html new file mode 100644 index 0000000..cb81481 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_auth_verify_data.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_auth_verify_data

    + + +SYNOPSIS + +
    
+    SilcBool silc_auth_verify_data(const unsigned char *payload,
+                               SilcUInt32 payload_len,
+                               SilcAuthMethod auth_method,
+                               const void *auth_data,
+                               SilcUInt32 auth_data_len, SilcHash hash,
+                               const void *id, SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Same as silc_auth_verify but the payload has not been parsed yet.
+    Verifies the authentication data directly from the Authentication
+    Payload. Supports all authentication methods. If the authentication
+    method is passphrase based then the `auth_data' and `auth_data_len'
+    are the passphrase and its length.  The passphrase MUST be UTF-8
+    encoded.  If the method is public key authentication then the
+    `auth_data' is the SilcPublicKey and the `auth_data_len' is ignored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_key_agreement_get_hostname.html b/docs/toolkit/manual/silcauth-silc_key_agreement_get_hostname.html new file mode 100644 index 0000000..7140aec --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_key_agreement_get_hostname.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_key_agreement_get_hostname

    + + +SYNOPSIS + +
    
+    char *silc_key_agreement_get_hostname(SilcKeyAgreementPayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the hostname in the payload. Caller must not free it.
+    The hostname is the host that is able to accept key negotiation
+    using the SILC Key Exchange protocol.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_key_agreement_get_port.html b/docs/toolkit/manual/silcauth-silc_key_agreement_get_port.html new file mode 100644 index 0000000..d2f16d6 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_key_agreement_get_port.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_key_agreement_get_port

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_key_agreement_get_port(SilcKeyAgreementPayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the port in the payload.  The port is the port on the
+    host returned by silc_key_agreement_get_hostname that is running
+    the SILC Key Exchange protocol.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_key_agreement_get_protocol.html b/docs/toolkit/manual/silcauth-silc_key_agreement_get_protocol.html new file mode 100644 index 0000000..43e71c6 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_key_agreement_get_protocol.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_key_agreement_get_protocol

    + + +SYNOPSIS + +
    
+    SilcUInt16
+    silc_key_agreement_get_protocol(SilcKeyAgreementPayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the protocol in the payload.  The protocol is either TCP (0)
+    or UDP (1).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_key_agreement_payload_encode.html b/docs/toolkit/manual/silcauth-silc_key_agreement_payload_encode.html new file mode 100644 index 0000000..fc5c864 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_key_agreement_payload_encode.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_key_agreement_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_key_agreement_payload_encode(char *hostname,
+                                                 SilcUInt16 protocol,
+                                                 SilcUInt16 port);
+
+
    +DESCRIPTION + +
    
+    Encodes the Key Agreement payload and returns the encoded buffer.
+    The `protocol' is 0 for TCP and 1 for UDP.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_key_agreement_payload_free.html b/docs/toolkit/manual/silcauth-silc_key_agreement_payload_free.html new file mode 100644 index 0000000..6f1961c --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_key_agreement_payload_free.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_key_agreement_payload_free

    + + +SYNOPSIS + +
    
+    void silc_key_agreement_payload_free(SilcKeyAgreementPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Key Agreement payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth-silc_key_agreement_payload_parse.html b/docs/toolkit/manual/silcauth-silc_key_agreement_payload_parse.html new file mode 100644 index 0000000..1e1f858 --- /dev/null +++ b/docs/toolkit/manual/silcauth-silc_key_agreement_payload_parse.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_key_agreement_payload_parse

    + + +SYNOPSIS + +
    
+    SilcKeyAgreementPayload
+    silc_key_agreement_payload_parse(const unsigned char *payload,
+                                     SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parses and returns an allocated Key Agreement payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Authentication Interface
    +SilcAuthMethod
    +SilcAuthPayload
    +silc_auth_payload_parse
    +silc_auth_payload_encode
    +silc_auth_payload_free
    +silc_auth_get_method
    +silc_auth_get_public_data
    +silc_auth_get_data
    +silc_auth_public_key_auth_generate
    +silc_auth_public_key_auth_generate_wpub
    +silc_auth_public_key_auth_verify
    +silc_auth_public_key_auth_verify_data
    +silc_auth_verify
    +silc_auth_verify_data
    +SilcKeyAgreementPayload
    +silc_key_agreement_payload_parse
    +silc_key_agreement_payload_encode
    +silc_key_agreement_payload_free
    +silc_key_agreement_get_hostname
    +silc_key_agreement_get_protocol
    +silc_key_agreement_get_port
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth.html b/docs/toolkit/manual/silcauth.html new file mode 100644 index 0000000..32ae1ae --- /dev/null +++ b/docs/toolkit/manual/silcauth.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcauth.html + + + + +
    + +SILC Authentication Interface
    Header: silcauth.h

    + + +DESCRIPTION + +
    
+ Implementations of the SILC Authentication Payload and authentication
+ routines.  The SILC Authentication Payload is used to deliver
+ authentication data usually from client to server in purpose of
+ gaining access to some service.  The Payload and the authentication
+ routines supports both passphrase and public key (signature) based
+ authentication.
+
+ This interface defines also the SILC Key Agreement Payload that is
+ used by client to agree on key material usually with another client
+ in the network.
+
+
  • SilcAuthMethod +
  • SilcAuthPayload +
  • silc_auth_payload_parse +
  • silc_auth_payload_encode +
  • silc_auth_payload_free +
  • silc_auth_get_method +
  • silc_auth_get_public_data +
  • silc_auth_get_data +
  • silc_auth_public_key_auth_generate +
  • silc_auth_public_key_auth_generate_wpub +
  • silc_auth_public_key_auth_verify +
  • silc_auth_public_key_auth_verify_data +
  • silc_auth_verify +
  • silc_auth_verify_data +
  • SilcKeyAgreementPayload +
  • silc_key_agreement_payload_parse +
  • silc_key_agreement_payload_encode +
  • silc_key_agreement_payload_free +
  • silc_key_agreement_get_hostname +
  • silc_key_agreement_get_protocol +
  • silc_key_agreement_get_port + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcauth.xref b/docs/toolkit/manual/silcauth.xref new file mode 100644 index 0000000..bca0436 --- /dev/null +++ b/docs/toolkit/manual/silcauth.xref @@ -0,0 +1,28 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcauth.h" "/home/priikone/silc1/doc/toolkit/silcauth.html" 0 + "SILC Authentication Interface" "/home/priikone/silc1/doc/toolkit/silcauth.html" 1 + "SilcAuthMethod" "/home/priikone/silc1/doc/toolkit/silcauth.html" 8 + "SilcAuthPayload" "/home/priikone/silc1/doc/toolkit/silcauth.html" 5 + "silc_auth_payload_parse" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_payload_encode" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_payload_free" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_get_method" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_get_public_data" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_get_data" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_public_key_auth_generate" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_public_key_auth_generate_wpub" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_public_key_auth_verify" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_public_key_auth_verify_data" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_verify" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_auth_verify_data" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "SilcKeyAgreementPayload" "/home/priikone/silc1/doc/toolkit/silcauth.html" 5 + "silc_key_agreement_payload_parse" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_key_agreement_payload_encode" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_key_agreement_payload_free" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_key_agreement_get_hostname" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_key_agreement_get_protocol" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + "silc_key_agreement_get_port" "/home/priikone/silc1/doc/toolkit/silcauth.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcber-SilcBerClass.html b/docs/toolkit/manual/silcber-SilcBerClass.html new file mode 100644 index 0000000..d976ca4 --- /dev/null +++ b/docs/toolkit/manual/silcber-SilcBerClass.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcBerClass

    + + +NAME + +
    
+    typedef enum { ... } SilcBerClass;
+
+
    +DESCRIPTION + +
    
+    Defines the BER classes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +BER Interface
    +SilcBerClass
    +SilcBerEncoding
    +silc_ber_encode
    +silc_ber_decode
    +silc_ber_encoded_len
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcber-SilcBerEncoding.html b/docs/toolkit/manual/silcber-SilcBerEncoding.html new file mode 100644 index 0000000..d942aea --- /dev/null +++ b/docs/toolkit/manual/silcber-SilcBerEncoding.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcBerEncoding

    + + +NAME + +
    
+    typedef enum { ... } SilcBerEncoding;
+
+
    +DESCRIPTION + +
    
+    Defines the BER encoding type.
+
+
    +



    +
    +     		+ + + + +
    +
    + +BER Interface
    +SilcBerClass
    +SilcBerEncoding
    +silc_ber_encode
    +silc_ber_decode
    +silc_ber_encoded_len
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcber-silc_ber_decode.html b/docs/toolkit/manual/silcber-silc_ber_decode.html new file mode 100644 index 0000000..bfd1d93 --- /dev/null +++ b/docs/toolkit/manual/silcber-silc_ber_decode.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ber_decode

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_ber_decode(SilcBuffer ber, SilcBerClass *ber_class,
+                    SilcBerEncoding *encoding, SilcUInt32 *tag,
+                    const unsigned char **data, SilcUInt32 *data_len,
+                    SilcBool *indefinite, SilcUInt32 *identifier_len);
+
+
    +DESCRIPTION + +
    
+    Decodesa a BER data from the buffer `ber'.  Returns the class,
+    encoding and the tag number for the BER data into `ber_class',
+    `encoding' and `tag'.  A pointer to the start of the data area is
+    returned into `data'.  If the length of the data is available from
+    the BER data the length is returned into `data_len'.  If the
+    `indefinite' is TRUE then the length found in `data_len' was found
+    by finding end-of-contents octets from the BER data.  The
+    `identifier_len' is the length of the BER header, and the length
+    of the entire BER object is `identifier_len' + `data_len'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +BER Interface
    +SilcBerClass
    +SilcBerEncoding
    +silc_ber_encode
    +silc_ber_decode
    +silc_ber_encoded_len
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcber-silc_ber_encode.html b/docs/toolkit/manual/silcber-silc_ber_encode.html new file mode 100644 index 0000000..ce947ce --- /dev/null +++ b/docs/toolkit/manual/silcber-silc_ber_encode.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ber_encode

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_ber_encode(SilcBuffer ber, SilcBerClass ber_class,
+                    SilcBerEncoding encoding, SilcUInt32 tag,
+                    const unsigned char *data, SilcUInt32 data_len,
+                    SilcBool indefinite);
+
+
    +DESCRIPTION + +
    
+    Encodes a BER data block into the `ber', which must already have
+    sufficient space allocated.  Caller can use silc_ber_encoded_len
+    function to determine how much to allocate space before calling this
+    function.  If the `indefinite' is TRUE then the BER block will not
+    include the length of the data in the BER block.
+
+
    +



    +
    +     		+ + + + +
    +
    + +BER Interface
    +SilcBerClass
    +SilcBerEncoding
    +silc_ber_encode
    +silc_ber_decode
    +silc_ber_encoded_len
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcber-silc_ber_encoded_len.html b/docs/toolkit/manual/silcber-silc_ber_encoded_len.html new file mode 100644 index 0000000..c441664 --- /dev/null +++ b/docs/toolkit/manual/silcber-silc_ber_encoded_len.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ber_encoded_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_ber_encoded_len(SilcUInt32 tag, SilcUInt32 data_len,
+                                    SilcBool indefinite);
+
+
    +DESCRIPTION + +
    
+    Calculates the length of the encoded BER data object.  This utility
+    function can be used to calculate how much to allocate space before
+    encoding with silc_ber_encode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +BER Interface
    +SilcBerClass
    +SilcBerEncoding
    +silc_ber_encode
    +silc_ber_decode
    +silc_ber_encoded_len
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcber.html b/docs/toolkit/manual/silcber.html new file mode 100644 index 0000000..1a4458a --- /dev/null +++ b/docs/toolkit/manual/silcber.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcber.html + + + + +
    + +BER Interface
    Header: silcber.h

    + + +DESCRIPTION + +
    
+ The Basic Encoding Rules (BER) is the data encoding format for the
+ ASN.1.  This interface provides routines for encoding and decoding
+ arbitraty BER data blocks.  Naturally, this interface can be used
+ to encode and decode DER blocks as well.  These routines does not
+ allocate any memory and have been optimized for general ASN.1 usage.
+
+ References: ITU-T X.690
+ http://www.itu.int/ITU-T/studygroups/com17/languages/X690_0702.pdf
+
+
  • SilcBerClass +
  • SilcBerEncoding +
  • silc_ber_encode +
  • silc_ber_decode +
  • silc_ber_encoded_len + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcber.xref b/docs/toolkit/manual/silcber.xref new file mode 100644 index 0000000..26ece8c --- /dev/null +++ b/docs/toolkit/manual/silcber.xref @@ -0,0 +1,12 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcber.h" "/home/priikone/silc1/doc/toolkit/silcber.html" 0 + "BER Interface" "/home/priikone/silc1/doc/toolkit/silcber.html" 1 + "SilcBerClass" "/home/priikone/silc1/doc/toolkit/silcber.html" 8 + "SilcBerEncoding" "/home/priikone/silc1/doc/toolkit/silcber.html" 8 + "silc_ber_encode" "/home/priikone/silc1/doc/toolkit/silcber.html" 4 + "silc_ber_decode" "/home/priikone/silc1/doc/toolkit/silcber.html" 4 + "silc_ber_encoded_len" "/home/priikone/silc1/doc/toolkit/silcber.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcbuffer-SilcBuffer.html b/docs/toolkit/manual/silcbuffer-SilcBuffer.html new file mode 100644 index 0000000..d2233c6 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-SilcBuffer.html @@ -0,0 +1,323 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcBuffer

    + + +NAME + +
    
+    typedef struct { ... } *SilcBuffer, SilcBufferStruct;
+
+
    +DESCRIPTION + +
    
+    SILC Buffer object. Following short description of the fields
+    of the buffer.
+
+
    +EXAMPLE + +
    
+    unsiged char *head;
+
+        Head of the allocated buffer. This is the start of the allocated
+        data area and remains as same throughout the lifetime of the buffer.
+        However, the end of the head area or the start of the currently valid
+        data area is variable.
+
+        --------------------------------
+        | head  | data         | tail  |
+        --------------------------------
+        ^       ^
+
+        Current head section in the buffer is sb->data - sb->head.
+
+    unsigned char *data;
+
+        Currently valid data area. This is the start of the currently valid
+        main data area. The data area is variable in all directions.
+
+        --------------------------------
+        | head  | data         | tail  |
+        --------------------------------
+                ^              ^
+
+        Current valid data area in the buffer is sb->tail - sb->data.
+
+     unsigned char *tail;
+
+        Tail of the buffer. This is the end of the currently valid data area
+        or start of the tail area. The start of the tail area is variable.
+
+        --------------------------------
+        | head  | data         | tail  |
+        --------------------------------
+                               ^       ^
+
+        Current tail section in the buffer is sb->end - sb->tail.
+
+    unsigned char *end;
+
+        End of the allocated buffer. This is the end of the allocated data
+        area and remains as same throughout the lifetime of the buffer.
+        Usually this field is not needed except when checking the size
+        of the buffer.
+
+        --------------------------------
+        | head  | data         | tail  |
+        --------------------------------
+                                       ^
+
+        Length of the entire buffer is (ie. truelen) sb->end - sb->head.
+
+     Currently valid data area is considered to be the main data area in
+     the buffer. However, the entire buffer is of course valid data and can
+     be used as such. Usually head section of the buffer includes different
+     kind of headers or similar. Data section includes the main data of
+     the buffer. Tail section can be seen as a reserve space of the data
+     section. Tail section can be pulled towards end, and thus the data
+     section becomes larger.
+
+ SILC Buffer is not thread-safe.  If the same SilcBuffer context must be
+ used in multithreaded environment concurrency control must be employed.
+
+
    +SOURCE + +
        typedef struct SilcBufferObject {
+      unsigned char *head;
+      unsigned char *data;
+      unsigned char *tail;
+      unsigned char *end;
+    } *SilcBuffer, SilcBufferStruct;
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_alloc.html b/docs/toolkit/manual/silcbuffer-silc_buffer_alloc.html new file mode 100644 index 0000000..1c5b083 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_alloc.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_alloc

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_alloc(SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Allocates new SilcBuffer and returns it.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_alloc_size.html b/docs/toolkit/manual/silcbuffer-silc_buffer_alloc_size.html new file mode 100644 index 0000000..8da5ca7 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_alloc_size.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_alloc_size

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_alloc_size(SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Allocates `len' bytes size buffer and moves the tail area automatically
+    `len' bytes so that the buffer is ready to use without calling the
+    silc_buffer_pull_tail.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_clear.html b/docs/toolkit/manual/silcbuffer-silc_buffer_clear.html new file mode 100644 index 0000000..07afe8a --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_clear.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_clear

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_buffer_clear(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Clears and initialiazes the buffer to the state as if it was just
+    allocated by silc_buffer_alloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_clone.html b/docs/toolkit/manual/silcbuffer-silc_buffer_clone.html new file mode 100644 index 0000000..fb8f3ec --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_clone.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_clone

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_clone(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Clones SilcBuffer. This generates new SilcBuffer and copies
+    everything from the source buffer. The result is exact clone of
+    the original buffer.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_copy.html b/docs/toolkit/manual/silcbuffer-silc_buffer_copy.html new file mode 100644 index 0000000..4f9d144 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_copy.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_copy

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_copy(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Generates copy of a SilcBuffer. This copies everything inside the
+    currently valid data area, nothing more. Use silc_buffer_clone to
+    copy entire buffer.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_data.html b/docs/toolkit/manual/silcbuffer-silc_buffer_data.html new file mode 100644 index 0000000..14e62a1 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_data.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_data

    + + +NAME + +
    
+    unsigned char *silc_buffer_data(SilcBuffer sb)
+
+
    +DESCRIPTION + +
    
+    Returns pointer to the data area of the buffer.
+
+
    +SOURCE + +
        #define silc_buffer_data(x) (x)->data
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_datalen.html b/docs/toolkit/manual/silcbuffer-silc_buffer_datalen.html new file mode 100644 index 0000000..4ebe8d2 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_datalen.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_datalen

    + + +NAME + +
    
+    #define silc_buffer_datalen ...
+
+
    +DESCRIPTION + +
    
+    Macro that can be used in function argument list to give the data
+    pointer and the data length, instead of calling both silc_buffer_data
+    and silc_buffer_len separately.
+
+
    +EXAMPLE + +
    
+    // Following are the same thing
+    silc_foo_function(foo, silc_buffer_datalen(buf));
+    silc_foo_function(foo, silc_buffer_data(buf), silc_buffer_len(buf));
+
+
    +SOURCE + +
        #define silc_buffer_datalen(x) (x) ? silc_buffer_data((x)) : NULL, \
+      (x) ? silc_buffer_len((x)) : 0
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_end.html b/docs/toolkit/manual/silcbuffer-silc_buffer_end.html new file mode 100644 index 0000000..4e65b35 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_end.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_end

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_buffer_end(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Moves the end of the data area to the end of the buffer.  The start
+    of the data area remains same.  If the start of data area is at the
+    start of the buffer, after this function returns the buffer's data
+    area length is the length of the entire buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_enlarge.html b/docs/toolkit/manual/silcbuffer-silc_buffer_enlarge.html new file mode 100644 index 0000000..1dbe8c5 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_enlarge.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_enlarge

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_enlarge(SilcBuffer sb, SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Enlarges the buffer by the amount of `size' if it doesn't have that
+    must space in the data area and in the tail area.  Moves the tail
+    area automatically after enlarging so that the current data area
+    is at least the size of `size'.  If there is more space than `size'
+    in the data area this does not do anything.  If there is enough
+    space in the tail area this merely moves the tail area to reveal
+    the extra space.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_free.html b/docs/toolkit/manual/silcbuffer-silc_buffer_free.html new file mode 100644 index 0000000..ce1d846 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_free.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_free

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_buffer_free(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Frees SilcBuffer.  Can be called safely `sb' as NULL.
+
+
    +NOTES + +
    
+    Must not be called for buffers allocated with silc_buffer_salloc,
+    silc_buffer_salloc_size, silc_buffer_scopy and silc_buffer_sclone.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_headlen.html b/docs/toolkit/manual/silcbuffer-silc_buffer_headlen.html new file mode 100644 index 0000000..d5bc91c --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_headlen.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +silc_buffer_headlen

    + + +NAME + +
    
+    SilcUInt32 silc_buffer_headlen(SilcBuffer sb)
+
+
    +DESCRIPTION + +
    
+    Returns the current length of the head data area of the buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_len.html b/docs/toolkit/manual/silcbuffer-silc_buffer_len.html new file mode 100644 index 0000000..017ce49 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_len.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +silc_buffer_len

    + + +NAME + +
    
+    SilcUInt32 silc_buffer_len(SilcBuffer sb)
+
+
    +DESCRIPTION + +
    
+    Returns the current length of the data area of the buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_pull.html b/docs/toolkit/manual/silcbuffer-silc_buffer_pull.html new file mode 100644 index 0000000..baba44c --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_pull.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_pull

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_pull(SilcBuffer sb, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Pulls current data area towards end. The length of the currently
+    valid data area is also decremented. Returns pointer to the data
+    area before pulling. Returns NULL on error.
+
+
    +EXAMPLE + +
    
+    ---------------------------------
+    | head  | data       | tail     |
+    ---------------------------------
+            ^
+            Pulls the start of the data area.
+
+    ---------------------------------
+    | head     | data    | tail     |
+    ---------------------------------
+            ^
+
+    silc_buffer_pull(sb, 20);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_pull_tail.html b/docs/toolkit/manual/silcbuffer-silc_buffer_pull_tail.html new file mode 100644 index 0000000..ce58a90 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_pull_tail.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_pull_tail

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_pull_tail(SilcBuffer sb, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Pulls current tail section towards end. Length of the current valid
+    data area is also incremented. Returns a pointer to the data area
+    before pulling. Returns NULL on error.
+
+
    +EXAMPLE + +
    
+    ---------------------------------
+    | head  | data       | tail     |
+    ---------------------------------
+                         ^
+                         Pulls the start of the tail section.
+
+    ---------------------------------
+    | head  | data           | tail |
+    ---------------------------------
+                         ^
+
+    silc_buffer_pull_tail(sb, 23);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_purge.html b/docs/toolkit/manual/silcbuffer-silc_buffer_purge.html new file mode 100644 index 0000000..0ad2a80 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_purge.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_purge

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_buffer_purge(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Same as silc_buffer_free but free's only the contents of the buffer
+    not the buffer itself.  The `sb' remains intact, data is freed.  Buffer
+    is ready for re-use after calling this function.
+
+
    +NOTES + +
    
+    Must not be called for buffers allocated with silc_buffer_salloc,
+    silc_buffer_salloc_size, silc_buffer_scopy and silc_buffer_sclone.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_push.html b/docs/toolkit/manual/silcbuffer-silc_buffer_push.html new file mode 100644 index 0000000..7dacf85 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_push.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_push

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_push(SilcBuffer sb, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Pushes current data area towards beginning. Length of the currently
+    valid data area is also incremented. Returns a pointer to the
+    data area before pushing. Returns NULL on error.
+
+
    +EXAMPLE + +
    
+    ---------------------------------
+    | head     | data    | tail     |
+    ---------------------------------
+               ^
+               Pushes the start of the data area.
+
+    ---------------------------------
+    | head  | data       | tail     |
+    ---------------------------------
+               ^
+
+    silc_buffer_push(sb, 20);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_push_tail.html b/docs/toolkit/manual/silcbuffer-silc_buffer_push_tail.html new file mode 100644 index 0000000..2d2a11f --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_push_tail.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_push_tail

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_push_tail(SilcBuffer sb, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Pushes current tail section towards beginning. Length of the current
+    valid data area is also decremented. Returns a pointer to the
+    tail section before pushing. Returns NULL on error.
+
+
    +EXAMPLE + +
    
+    ---------------------------------
+    | head  | data           | tail |
+    ---------------------------------
+                             ^
+                             Pushes the start of the tail section.
+
+    ---------------------------------
+    | head  | data       | tail     |
+    ---------------------------------
+                             ^
+
+    silc_buffer_push_tail(sb, 23);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_put.html b/docs/toolkit/manual/silcbuffer-silc_buffer_put.html new file mode 100644 index 0000000..4bf607d --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_put.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_put

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_put(SilcBuffer sb,
+                                     const unsigned char *data,
+                                     SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Puts data at the start of the valid data area. Returns a pointer
+    to the copied data area.  Returns NULL on error.
+
+
    +EXAMPLE + +
    
+    ---------------------------------
+    | head  | data       | tail     |
+    ---------------------------------
+            ^
+            Puts data to the data section.
+
+    silc_buffer_put(sb, data, data_len);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_put_head.html b/docs/toolkit/manual/silcbuffer-silc_buffer_put_head.html new file mode 100644 index 0000000..0504034 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_put_head.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_put_head

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_put_head(SilcBuffer sb,
+                                          const unsigned char *data,
+                                          SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Puts data at the head of the buffer. Returns pointer to the copied
+    data area. Returns NULL on error.
+
+
    +EXAMPLE + +
    
+    ---------------------------------
+    | head  | data       | tail     |
+    ---------------------------------
+    ^
+    Puts data to the head section.
+
+    silc_buffer_put_head(sb, data, data_len);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_put_tail.html b/docs/toolkit/manual/silcbuffer-silc_buffer_put_tail.html new file mode 100644 index 0000000..0fa71cd --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_put_tail.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_put_tail

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_put_tail(SilcBuffer sb,
+                                          const unsigned char *data,
+                                          SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Puts data at the tail of the buffer. Returns pointer to the copied
+    data area.  Returns NULL on error.
+
+
    +EXAMPLE + +
    
+    ---------------------------------
+    | head  | data           | tail |
+    ---------------------------------
+                             ^
+                               Puts data to the tail section.
+
+    silc_buffer_put_tail(sb, data, data_len);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_realloc.html b/docs/toolkit/manual/silcbuffer-silc_buffer_realloc.html new file mode 100644 index 0000000..95d4961 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_realloc.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_realloc

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_realloc(SilcBuffer sb, SilcUInt32 newsize);
+
+
    +DESCRIPTION + +
    
+    Reallocates buffer. Old data is saved into the new buffer. The buffer
+    is exact clone of the old one except that there is now more space
+    at the end of buffer.  This always returns the same `sb' unless `sb'
+    was NULL. Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_realloc_size.html b/docs/toolkit/manual/silcbuffer-silc_buffer_realloc_size.html new file mode 100644 index 0000000..7ff2afe --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_realloc_size.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_realloc_size

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_realloc_size(SilcBuffer sb, SilcUInt32 newsize);
+
+
    +DESCRIPTION + +
    
+    Same as silc_buffer_realloc but moves moves the tail area
+    automatically so that the buffer is ready to use without calling the
+    silc_buffer_pull_tail.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_reset.html b/docs/toolkit/manual/silcbuffer-silc_buffer_reset.html new file mode 100644 index 0000000..a420575 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_reset.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_reset

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_buffer_reset(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Resets the buffer to the state as if it was just allocated by
+    silc_buffer_alloc.  This does not clear the data area.  Use
+    silc_buffer_clear if you also want to clear the data area.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_salloc.html b/docs/toolkit/manual/silcbuffer-silc_buffer_salloc.html new file mode 100644 index 0000000..430804e --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_salloc.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_salloc

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_salloc(SilcStack stack, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Allocates new SilcBuffer and returns it.
+
+    This routine use SilcStack are memory source.  If `stack' is NULL
+    reverts back to normal allocating routine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_salloc_size.html b/docs/toolkit/manual/silcbuffer-silc_buffer_salloc_size.html new file mode 100644 index 0000000..4cd9087 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_salloc_size.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_salloc_size

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_salloc_size(SilcStack stack, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Allocates `len' bytes size buffer and moves the tail area automatically
+    `len' bytes so that the buffer is ready to use without calling the
+    silc_buffer_pull_tail.
+
+    This routine use SilcStack are memory source.  If `stack' is NULL
+    reverts back to normal allocating routine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_sclone.html b/docs/toolkit/manual/silcbuffer-silc_buffer_sclone.html new file mode 100644 index 0000000..e134c00 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_sclone.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_sclone

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_sclone(SilcStack stack, SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Clones SilcBuffer. This generates new SilcBuffer and copies
+    everything from the source buffer. The result is exact clone of
+    the original buffer.
+
+    This routine use SilcStack are memory source.  If `stack' is NULL
+    reverts back to normal allocating routine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_scopy.html b/docs/toolkit/manual/silcbuffer-silc_buffer_scopy.html new file mode 100644 index 0000000..667052b --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_scopy.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_scopy

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_scopy(SilcStack stack, SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Generates copy of a SilcBuffer. This copies everything inside the
+    currently valid data area, nothing more. Use silc_buffer_clone to
+    copy entire buffer.
+
+    This routine use SilcStack are memory source.  If `stack' is NULL
+    reverts back to normal allocating routine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_senlarge.html b/docs/toolkit/manual/silcbuffer-silc_buffer_senlarge.html new file mode 100644 index 0000000..981e74f --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_senlarge.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_senlarge

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_senlarge(SilcStack stack, SilcBuffer sb,
+                                    SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Enlarges the buffer by the amount of `size' if it doesn't have that
+    must space in the data area and in the tail area.  Moves the tail
+    area automatically after enlarging so that the current data area
+    is at least the size of `size'.  If there is more space than `size'
+    in the data area this does not do anything.  If there is enough
+    space in the tail area this merely moves the tail area to reveal
+    the extra space.  Returns FALSE on error.
+
+    This routine use SilcStack are memory source.  If `stack' is NULL
+    reverts back to normal allocating routine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_set.html b/docs/toolkit/manual/silcbuffer-silc_buffer_set.html new file mode 100644 index 0000000..9958bf9 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_set.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_set

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_buffer_set(SilcBuffer sb,
+                           unsigned char *data,
+                         SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Sets the `data' and `data_len' to the buffer pointer sent as argument.
+    The data area is automatically set to the `data_len'. This function
+    can be used to set the data to static buffer without needing any
+    memory allocations. The `data' will not be copied to the buffer.
+
+
    +EXAMPLE + +
    
+    SilcBufferStruct buf;
+    silc_buffer_set(&buf, data, data_len);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_srealloc.html b/docs/toolkit/manual/silcbuffer-silc_buffer_srealloc.html new file mode 100644 index 0000000..168829f --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_srealloc.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_srealloc

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_srealloc(SilcStack stack,
+                                    SilcBuffer sb, SilcUInt32 newsize);
+
+
    +DESCRIPTION + +
    
+    Reallocates buffer. Old data is saved into the new buffer. The buffer
+    is exact clone of the old one except that there is now more space
+    at the end of buffer.
+
+    This routine use SilcStack are memory source.  If `stack' is NULL
+    reverts back to normal allocating routine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_srealloc_size.html b/docs/toolkit/manual/silcbuffer-silc_buffer_srealloc_size.html new file mode 100644 index 0000000..2f4fcc4 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_srealloc_size.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_srealloc_size

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBuffer silc_buffer_srealloc_size(SilcStack stack,
+                                         SilcBuffer sb, SilcUInt32 newsize);
+
+
    +DESCRIPTION + +
    
+    Same as silc_buffer_srealloc but moves moves the tail area
+    automatically so that the buffer is ready to use without calling the
+    silc_buffer_pull_tail.
+
+    This routine use SilcStack are memory source.  If `stack' is NULL
+    reverts back to normal allocating routine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_start.html b/docs/toolkit/manual/silcbuffer-silc_buffer_start.html new file mode 100644 index 0000000..f91b091 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_start.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_start

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_buffer_start(SilcBuffer sb);
+
+
    +DESCRIPTION + +
    
+    Moves the data area at the start of the buffer.  The tail area remains
+    as is.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_steal.html b/docs/toolkit/manual/silcbuffer-silc_buffer_steal.html new file mode 100644 index 0000000..974e45a --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_steal.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_steal

    + + +SYNOPSIS + +
    
+    static inline
+    unsigned char *silc_buffer_steal(SilcBuffer sb, SilcUInt32 *data_len);
+
+
    +DESCRIPTION + +
    
+    Steals the data from the buffer `sb'.  This returns pointer to the
+    start of the buffer and the true length of that buffer.  The `sb'
+    cannot be used anymore after calling this function because the
+    data buffer was stolen.  The `sb' must be freed with silc_buffer_free.
+    The caller is responsible of freeing the stolen data buffer with
+    silc_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_taillen.html b/docs/toolkit/manual/silcbuffer-silc_buffer_taillen.html new file mode 100644 index 0000000..c4efd57 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_taillen.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +silc_buffer_taillen

    + + +NAME + +
    
+    SilcUInt32 silc_buffer_taillen(SilcBuffer sb)
+
+
    +DESCRIPTION + +
    
+    Returns the current length of the tail data area of the buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer-silc_buffer_truelen.html b/docs/toolkit/manual/silcbuffer-silc_buffer_truelen.html new file mode 100644 index 0000000..b5f0922 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer-silc_buffer_truelen.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +silc_buffer_truelen

    + + +NAME + +
    
+    SilcUInt32 silc_buffer_truelen(SilcBuffer sb)
+
+
    +DESCRIPTION + +
    
+    Returns the true length of the buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Interface
    +SilcBuffer
    +silc_buffer_data
    +silc_buffer_datalen
    +silc_buffer_truelen
    +silc_buffer_len
    +silc_buffer_headlen
    +silc_buffer_taillen
    +silc_buffer_alloc
    +silc_buffer_free
    +silc_buffer_steal
    +silc_buffer_purge
    +silc_buffer_set
    +silc_buffer_pull
    +silc_buffer_push
    +silc_buffer_pull_tail
    +silc_buffer_push_tail
    +silc_buffer_put_head
    +silc_buffer_put
    +silc_buffer_put_tail
    +silc_buffer_alloc_size
    +silc_buffer_reset
    +silc_buffer_clear
    +silc_buffer_start
    +silc_buffer_end
    +silc_buffer_copy
    +silc_buffer_clone
    +silc_buffer_realloc
    +silc_buffer_realloc_size
    +silc_buffer_enlarge
    +silc_buffer_salloc
    +silc_buffer_salloc_size
    +silc_buffer_srealloc
    +silc_buffer_srealloc_size
    +silc_buffer_senlarge
    +silc_buffer_scopy
    +silc_buffer_sclone
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer.html b/docs/toolkit/manual/silcbuffer.html new file mode 100644 index 0000000..37e2f35 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcbuffer.html + + + + +
    + +SILC Buffer Interface
    Header: silcbuffer.h

    + + +DESCRIPTION + +
    
+ SilcBuffer is very simple and easy to use, yet you can do to the
+ buffer almost anything you want with its method functions. The buffer
+ is constructed of four different data sections that in whole creates
+ the allocated data area.
+
+
  • SilcBuffer +
  • silc_buffer_data +
  • silc_buffer_datalen +
  • silc_buffer_truelen +
  • silc_buffer_len +
  • silc_buffer_headlen +
  • silc_buffer_taillen +
  • silc_buffer_alloc +
  • silc_buffer_free +
  • silc_buffer_steal +
  • silc_buffer_purge +
  • silc_buffer_set +
  • silc_buffer_pull +
  • silc_buffer_push +
  • silc_buffer_pull_tail +
  • silc_buffer_push_tail +
  • silc_buffer_put_head +
  • silc_buffer_put +
  • silc_buffer_put_tail +
  • silc_buffer_alloc_size +
  • silc_buffer_reset +
  • silc_buffer_clear +
  • silc_buffer_start +
  • silc_buffer_end +
  • silc_buffer_copy +
  • silc_buffer_clone +
  • silc_buffer_realloc +
  • silc_buffer_realloc_size +
  • silc_buffer_enlarge +
  • silc_buffer_salloc +
  • silc_buffer_salloc_size +
  • silc_buffer_srealloc +
  • silc_buffer_srealloc_size +
  • silc_buffer_senlarge +
  • silc_buffer_scopy +
  • silc_buffer_sclone + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffer.xref b/docs/toolkit/manual/silcbuffer.xref new file mode 100644 index 0000000..1501a25 --- /dev/null +++ b/docs/toolkit/manual/silcbuffer.xref @@ -0,0 +1,43 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcbuffer.h" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 0 + "SILC Buffer Interface" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 1 + "SilcBuffer" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 5 + "silc_buffer_data" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_datalen" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_truelen" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 8 + "silc_buffer_len" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 8 + "silc_buffer_headlen" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 8 + "silc_buffer_taillen" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 8 + "silc_buffer_alloc" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_free" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_steal" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_purge" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_set" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_pull" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_push" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_pull_tail" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_push_tail" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_put_head" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_put" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_put_tail" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_alloc_size" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_reset" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_clear" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_start" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_end" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_copy" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_clone" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_realloc" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_realloc_size" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_enlarge" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_salloc" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_salloc_size" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_srealloc" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_srealloc_size" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_senlarge" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_scopy" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + "silc_buffer_sclone" "/home/priikone/silc1/doc/toolkit/silcbuffer.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STRFMT_END.html b/docs/toolkit/manual/silcbuffmt-SILC_STRFMT_END.html new file mode 100644 index 0000000..6d65664 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STRFMT_END.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STRFMT_END

    + + +NAME + +
    
+    #define SILC_STRFMT_END ...
+
+
    +DESCRIPTION + +
    
+    Marks end of the argument list in silc_buffer_strformat function.
+    This must be at the end of the argument list or error will occur.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_*_CHAR.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_CHAR.html new file mode 100644 index 0000000..da8edb5 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_CHAR.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_*_CHAR

    + + +NAME + +
    
+    #define SILC_STR_UI_CHAR() ...
+    #define SILC_STR_SI_CHAR() ...
+
+
    +DESCRIPTION + +
    
+    One signed/unsigned character.
+
+    Formatting:    SILC_STR_SI_CHAR(char)
+                   SILC_STR_UI_CHAR(unsigned char)
+    Unformatting:  SILC_STR_SI_CHAR(char *)
+                   SILC_STR_UI_CHAR(unsigned char *)
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT.html new file mode 100644 index 0000000..1a9c0e0 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_*_INT

    + + +NAME + +
    
+    #define SILC_STR_UI_INT() ...
+    #define SILC_STR_SI_INT() ...
+
+
    +DESCRIPTION + +
    
+    SilcInt32/SilcUInt32.
+
+    Formatting:    SILC_STR_SI_INT(SilcInt32)
+                   SILC_STR_UI_INT(SilcUInt32)
+    Unformatting:  SILC_STR_SI_INT(SilcInt32 *)
+                   SILC_STR_UI_INT(SilcUInt32 *)
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT64.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT64.html new file mode 100644 index 0000000..d5ebfae --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_INT64.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_*_INT64

    + + +NAME + +
    
+    #define SILC_STR_UI_INT64() ...
+    #define SILC_STR_SI_INT64() ...
+
+
    +DESCRIPTION + +
    
+    SilcInt64/SilcUInt64.
+
+     Formatting:    SILC_STR_SI_INT64(SilcInt64)
+                    SILC_STR_UI_INT64(SilcUInt64)
+     Unformatting:  SILC_STR_SI_INT64(SilcInt64 *)
+                    SILC_STR_UI_INT64(SilcUInt64 *)
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_*_NSTRING.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_NSTRING.html new file mode 100644 index 0000000..425fe67 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_NSTRING.html @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_*_NSTRING

    + + +NAME + +
    
+    #define SILC_STR_UI8_NSTRING() ...
+    #define SILC_STR_UI8_NSTRING_ALLOC() ...
+    #define SILC_STR_UI16_NSTRING() ...
+    #define SILC_STR_UI16_NSTRING_ALLOC() ...
+    #define SILC_STR_UI32_NSTRING() ...
+    #define SILC_STR_UI32_NSTRING_ALLOC() ...
+
+
    +DESCRIPTION + +
    
+    Unsigned string. Second argument is the length of the string.
+
+    Formatting:    SILC_STR_UI32_NSTRING(unsigned char *, SilcUInt32)
+    Unformatting:  SILC_STR_UI32_NSTRING(unsigned char **, SilcUInt32 *)
+
+    Unformatting procedure will check for length of the string from the
+    buffer before trying to get the string out. Thus, one *must* format the
+    length as UI_INT or UI_SHORT into the buffer *before* formatting the
+    actual string to the buffer, and, in unformatting one must ignore the
+    length of the string because unformatting procedure will take it
+    automatically.
+
+     Example:
+
+     Formatting:    ..., SILC_STR_UI_INT(strlen(string)),
+                         SILC_STR_UI32_NSTRING(string, strlen(string)), ...
+     Unformatting:  ..., SILC_STR_UI32_NSTRING(&string, &len), ...
+
+    I.e., you can ignore the formatted length field in unformatting. The
+    length taken from the buffer is returned to the pointer sent as
+    argument (&len in above example).
+
+    UI8, UI16 and UI32 means that the length is considered to be
+    either char (8 bits), short (16 bits) or int (32 bits) in
+    unformatting.
+
+    _ALLOC routines automatically allocates memory for the variable sent
+    as argument in unformatting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_*_SHORT.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_SHORT.html new file mode 100644 index 0000000..76e45fa --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_SHORT.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_*_SHORT

    + + +NAME + +
    
+    #define SILC_STR_UI_SHORT() ...
+    #define SILC_STR_SI_SHORT() ...
+
+
    +DESCRIPTION + +
    
+    SilcInt16/SilcUInt16.
+
+    Formatting:    SILC_STR_SI_SHORT(SilcInt16)
+                   SILC_STR_UI_SHORT(SilcUInt16)
+    Unformatting:  SILC_STR_SI_SHORT(SilcInt16 *)
+                   SILC_STR_UI_SHORT(SilcUInt16 *)
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_*_STRING.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_STRING.html new file mode 100644 index 0000000..da60303 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_*_STRING.html @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_*_STRING

    + + +NAME + +
    
+    #define SILC_STR_UI8_STRING() ...
+    #define SILC_STR_UI8_STRING_ALLOC() ...
+    #define SILC_STR_UI16_STRING() ...
+    #define SILC_STR_UI16_STRING_ALLOC() ...
+    #define SILC_STR_UI32_STRING() ...
+    #define SILC_STR_UI32_STRING_ALLOC() ...
+
+
    +DESCRIPTION + +
    
+    Unsigned NULL terminated string. Note that the string must be
+    NULL terminated because strlen() will be used to get the length of
+    the string.
+
+    Formatting:    SILC_STR_UI32_STRING(unsigned char *)
+    Unformatting:  SILC_STR_UI32_STRING(unsigned char **)
+
+    Unformatting procedure will check for length of the string from the
+    buffer before trying to get the string out. Thus, one *must* format the
+    length as UI_INT or UI_SHORT into the buffer *before* formatting the
+    actual string to the buffer, and, in unformatting one must ignore the
+    length of the string because unformatting procedure will take it
+    automatically.
+
+    Example:
+
+    Formatting:    ..., SILC_STR_UI_INT(strlen(string)),
+                        SILC_STR_UI32_STRING(string), ...
+    Unformatting:  ..., SILC_STR_UI32_STRING(&string), ...
+
+    I.e., you can ignore the formatted length field in unformatting.
+
+    UI8, UI16 and UI32 means that the length is considered to be
+    either char (8 bits), short (16 bits) or int (32 bits) in
+    unformatting.
+
+    _ALLOC routines automatically allocates memory for the variable sent
+    as argument in unformatting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_ADVANCE.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_ADVANCE.html new file mode 100644 index 0000000..9f39aa3 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_ADVANCE.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_ADVANCE

    + + +NAME + +
    
+    #define SILC_STR_ADVANCE ...
+
+
    +DESCRIPTION + +
    
+    Advance the buffer to the end of the data after the formatting is
+    done.  In normal operation when the formatted data is written the
+    buffer is located at the start of the data.  With SILC_STR_ADVANCE
+    the buffer will be located at the end of the data.  This makes it
+    easy to add new data immediately after the previously added data.
+    The SILC_STR_ADVANCE may also be used in unformatting.
+
+
    +EXAMPLE + +
    
+    do {
+      len = read(fd, buf, sizeof(buf));
+      if (len > 0)
+        // Add read data to the buffer
+        silc_buffer_format(buffer,
+                           SILC_STR_ADVANCE,
+                           SILC_STR_DATA(buf, len),
+                           SILC_STR_END);
+    } while (len > 0);
+
+    // Move to beginning of buffer
+    silc_buffer_start(buffer);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_BUFFER.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_BUFFER.html new file mode 100644 index 0000000..14368f4 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_BUFFER.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_BUFFER

    + + +NAME + +
    
+    #define SILC_STR_BUFFER() ...
+    #define SILC_STR_BUFFER_ALLOC() ...
+
+
    +DESCRIPTION + +
    
+    SilcBuffer formatting.
+
+    Formatting:    SILC_STR_BUFFER(SilcBuffer)
+    Unformatting:  SILC_STR_BUFFER(SilcBuffer)
+
+    This type can be used to format and unformat SilcBuffer.  Note that, the
+    length of the buffer will be automatically encoded into the buffer as
+    a 32-bit integer.  In unformatting the SilcBuffer context must be
+    pre-allocated.
+
+    _ALLOC routines automatically allocates memory inside SilcBuffer in
+    unformatting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_DATA.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_DATA.html new file mode 100644 index 0000000..8207034 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_DATA.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_DATA

    + + +NAME + +
    
+    #define SILC_STR_DATA() ...
+    #define SILC_STR_DATA_ALLOC() ...
+
+
    +DESCRIPTION + +
    
+    Binary data formatting.  Second argument is the length of the data.
+
+    Formatting:    SILC_STR_DATA(unsigned char *, SilcUInt32)
+    Unformatting:  SILC_STR_DATA(unsigned char **, SilcUInt32)
+
+    This type can be used to take arbitrary size data block from the buffer
+    by sending the requested amount of bytes as argument.
+
+    _ALLOC routines automatically allocates memory for the variable sent
+    as argument in unformatting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_END.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_END.html new file mode 100644 index 0000000..35ae353 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_END.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_END

    + + +NAME + +
    
+    #define SILC_STR_END ...
+
+
    +DESCRIPTION + +
    
+    Marks end of the argument list. This must be at the end of the
+    argument list or error will occur.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_FUNC.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_FUNC.html new file mode 100644 index 0000000..9bae9f0 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_FUNC.html @@ -0,0 +1,280 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_FUNC

    + + +NAME + +
    
+    #define SILC_STR_FUNC() ...
+
+
    +DESCRIPTION + +
    
+    SilcBuffer formatting.
+
+    Formatting:    SILC_STR_FUNC(function, void *value, void *context)
+    Unformatting:  SILC_STR_FUNC(function, void **value, void *context)
+
+    This type can be used to call the `function' of the type
+    SilcBufferFormatFunc or SilcBufferUnformatFunc to encode or decode
+    the `value'.  In encoding the `value' will be passed to the `function'
+    and can be encoded into the buffer.  The buffer will be passed as
+    well to the `function' at the location where SILC_STR_FUNC is placed
+    in formatting.  The `context' delivers caller specific context to
+    the `function'
+
+    In unformatting the `function' will decode the encoded type and
+    return it to `value' pointer.  The decoding function should decide
+    itself whether to allocate or not the decoded value.
+
+    The `function' does not have to encode anything and passing `value'
+    as NULL is allowed.  The `function' could for example modify the
+    existing buffer.
+
+
    +EXAMPLE + +
    
+    // Encode payload, encrypt and compute MAC.
+    silc_buffer_format(buf,
+                       SILC_STR_FUNC(foo_encode_id, id, ctx),
+                       SILC_STR_UI_SHORT(len),
+                       SILC_STR_DATA(data, len),
+                       SILC_STR_FUNC(foo_buf_encrypt, NULL, key),
+                       SILC_STR_FUNC(foo_buf_hmac, NULL, hmac),
+                       SILC_STR_DATA(iv, iv_len);
+                       SILC_STR_END);
+
+    // Check MAC, decrypt and decode payload
+    silc_buffer_unformat(buf,
+                         SILC_STR_FUNC(foo_buf_hmac, NULL, hmac),
+                         SILC_STR_FUNC(foo_buf_decrypt, NULL, key),
+                         SILC_STR_FUNC(foo_decode_id, &id, ctx),
+                         SILC_STR_UI_SHORT(&len),
+                         SILC_STR_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SILC_STR_OFFSET.html b/docs/toolkit/manual/silcbuffmt-SILC_STR_OFFSET.html new file mode 100644 index 0000000..020aa3c --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SILC_STR_OFFSET.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_STR_OFFSET

    + + +NAME + +
    
+    #define SILC_STR_OFFSET() ...
+
+
    +DESCRIPTION + +
    
+    Offset in buffer.  This can be used in formatting and unformatting to
+    move the data pointer of the buffer either forwards (positive offset)
+    or backwards (negative offset).  It can be used to for example skip
+    some types during unformatting.
+
+    Example:
+
+    ..., SILC_STR_OFFSET(5), ...
+    ..., SILC_STR_OFFSET(-3), ...
+
+    Moves the data pointer at the point of the offset either forward
+    or backward and then moves to the next type.  Multiple SILC_STR_OFFSETs
+    can be used in formatting and unformatting at the same time.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SilcBufferFormatFunc.html b/docs/toolkit/manual/silcbuffmt-SilcBufferFormatFunc.html new file mode 100644 index 0000000..1aedd5b --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SilcBufferFormatFunc.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcBufferFormatFunc

    + + +SYNOPSIS + +
    
+    typedef int (*SilcBufferFormatFunc)(SilcBuffer buffer,
+                                        void *value,
+                                        void *context);
+
+
    +DESCRIPTION + +
    
+    Formatting function callback given with SILC_STR_FUNC type.  The
+    `buffer' is the buffer being formatted at the location where the
+    SILC_STR_FUNC was placed in formatting.  The function should call
+    silc_buffer_enlarge before it adds the data to the buffer to make
+    sure that it has enough space.  The buffer->head points to the
+    start of the buffer and silc_buffer_headlen() gives the length
+    of the currently formatted data area.  It is also possible to use
+    silc_buffer_format with `buffer' which will enlarge the buffer if
+    needed.
+
+    The `value' is the value given to SILC_STR_FUNC that is to be formatted
+    into the buffer.  It may be NULL if the function is not formatting
+    new data into the buffer.  The `context' is caller specific context.
+    Returns -1 on error and length of the formatted value otherwise, and
+    0 if nothing was formatted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SilcBufferParamType.html b/docs/toolkit/manual/silcbuffmt-SilcBufferParamType.html new file mode 100644 index 0000000..90fa13a --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SilcBufferParamType.html @@ -0,0 +1,281 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcBufferParamType

    + + +NAME + +
    
+    typedef enum { ... } SilcBufferParamType;
+
+
    +DESCRIPTION + +
    
+    Buffer parameter types.  These are not needed when formatting or
+    unformatting buffers.  Use the macros such as SILC_STR_UI_CHAR and
+    others instead.  These types may be used when describing what a
+    buffer looks like, and how it may be formatted and unformatted.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_PARAM_SI8_CHAR,             /* Signed 8-bit char */
+      SILC_PARAM_UI8_CHAR,             /* Unsigned 8-bit char */
+      SILC_PARAM_SI16_SHORT,           /* Signed 16-bit int */
+      SILC_PARAM_UI16_SHORT,           /* Unsigned 16-bit int */
+      SILC_PARAM_SI32_INT,             /* Signed 32-bit int */
+      SILC_PARAM_UI32_INT,             /* Unsigned 32-bit int */
+      SILC_PARAM_SI64_INT,             /* Signed 64-bit int */
+      SILC_PARAM_UI64_INT,             /* Unsigned 64-bit int */
+      SILC_PARAM_UI8_STRING,           /* String (max len 8-bits)*/
+      SILC_PARAM_UI16_STRING,          /* String (max len 16-bits) */
+      SILC_PARAM_UI32_STRING,          /* String (max len 32-bits) */
+      SILC_PARAM_BUFFER,               /* SilcBuffer */
+    
+      /* Internal types */
+      SILC_PARAM_DATA,                 /* Binary data */
+      SILC_PARAM_UI8_NSTRING,          /* String (max len 8-bits) */
+      SILC_PARAM_UI16_NSTRING,         /* String (max len 16-bits) */
+      SILC_PARAM_UI32_NSTRING,         /* String (max len 32-bits) */
+      SILC_PARAM_UI8_STRING_ALLOC,     /* Alloc + memcpy */
+      SILC_PARAM_UI16_STRING_ALLOC,    /* Alloc + memcpy */
+      SILC_PARAM_UI32_STRING_ALLOC,    /* Alloc + memcpy */
+      SILC_PARAM_UI8_NSTRING_ALLOC,    /* Alloc + memcpy */
+      SILC_PARAM_UI16_NSTRING_ALLOC,   /* Alloc + memcpy */
+      SILC_PARAM_UI32_NSTRING_ALLOC,   /* Alloc + memcpy */
+      SILC_PARAM_DATA_ALLOC,           /* Alloc + memcpy */
+      SILC_PARAM_BUFFER_ALLOC,         /* Alloc + memcpy */
+    
+      SILC_PARAM_OFFSET,
+      SILC_PARAM_ADVANCE,
+      SILC_PARAM_FUNC,
+    
+      SILC_PARAM_UI_XNSTRING,
+      SILC_PARAM_UI_XNSTRING_ALLOC,
+    
+      SILC_PARAM_END
+    } SilcBufferParamType;
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SilcBufferSFormatFunc.html b/docs/toolkit/manual/silcbuffmt-SilcBufferSFormatFunc.html new file mode 100644 index 0000000..1fe4a71 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SilcBufferSFormatFunc.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcBufferSFormatFunc

    + + +SYNOPSIS + +
    
+    typedef int (*SilcBufferSFormatFunc)(SilcStack stack,
+                                         SilcBuffer buffer,
+                                         void *value,
+                                         void *context);
+
+
    +DESCRIPTION + +
    
+    Formatting function callback given with SILC_STR_FUNC type.  The
+    `buffer' is the buffer being formatted at the location where the
+    SILC_STR_FUNC was placed in formatting.  The function should call
+    silc_buffer_senlarge before it adds the data to the buffer to make
+    sure that it has enough space.  The buffer->head points to the
+    start of the buffer and silc_buffer_headlen() gives the length
+    of the currently formatted data area.  It is also possible to use
+    silc_buffer_sformat with `buffer' which will enlarge the buffer if
+    needed.
+
+    The `value' is the value given to SILC_STR_FUNC that is to be formatted
+    into the buffer.  It may be NULL if the function is not formatting
+    new data into the buffer.  The `context' is caller specific context.
+    Returns -1 on error and length of the formatted value otherwise, and
+    0 if nothing was formatted.
+
+    This is same as SilcBufferFormatFunc except the SilcStack will be
+    delivered.  This callback must be used when SilcStack is used with
+    formatting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SilcBufferSUnformatFunc.html b/docs/toolkit/manual/silcbuffmt-SilcBufferSUnformatFunc.html new file mode 100644 index 0000000..6f9dea6 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SilcBufferSUnformatFunc.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcBufferSUnformatFunc

    + + +SYNOPSIS + +
    
+    typedef int (*SilcBufferSUnformatFunc)(SilcStack stack,
+                                           SilcBuffer buffer,
+                                           void **value,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    Unformatting function callback given with SILC_STR_FUNC type.  The
+    `buffer' is the buffer being unformatted and is at the location where
+    the SILC_STR_FUNC was placed in unformatting.  The function should
+    check there is enough data in the `buffer' before trying to decode
+    from it.
+
+    If this function unformats anything from the buffer its value is to
+    be returned to the `value' pointer.  The implementation should itself
+    decide whether the unformatted value is allocated or not.  If this
+    function does not unformat anything, nothing is returned to `value'
+
+    The `context' is caller specific context.  Returns -1 on error, and
+    length of the unformatted value otherwise, and 0 if nothing was
+    unformatted.
+
+    This is same as SilcBufferUnformatFunc except the SilcStack will be
+    delivered.  This callback must be used when SilcStack is used with
+    unformatting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-SilcBufferUnformatFunc.html b/docs/toolkit/manual/silcbuffmt-SilcBufferUnformatFunc.html new file mode 100644 index 0000000..b952286 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-SilcBufferUnformatFunc.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcBufferUnformatFunc

    + + +SYNOPSIS + +
    
+    typedef int (*SilcBufferUnformatFunc)(SilcBuffer buffer,
+                                          void **value,
+                                          void *context);
+
+
    +DESCRIPTION + +
    
+    Unformatting function callback given with SILC_STR_FUNC type.  The
+    `buffer' is the buffer being unformatted and is at the location where
+    the SILC_STR_FUNC was placed in unformatting.  The function should
+    check there is enough data in the `buffer' before trying to decode
+    from it.
+
+    If this function unformats anything from the buffer its value is to
+    be returned to the `value' pointer.  The implementation should itself
+    decide whether the unformatted value is allocated or not.  If this
+    function does not unformat anything, nothing is returned to `value'
+
+    The `context' is caller specific context.  Returns -1 on error, and
+    length of the unformatted value otherwise, and 0 if nothing was
+    unformatted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_format.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_format.html new file mode 100644 index 0000000..00f5999 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_format.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_format

    + + +SYNOPSIS + +
    
+    int silc_buffer_format(SilcBuffer dst, ...);
+
+
    +DESCRIPTION + +
    
+    Formats a buffer from a variable argument list.  Returns -1 on error
+    and the length of the formatted buffer otherwise.  The buffer is
+    enlarged automatically during formatting, if it doesn't already have
+    enough space.
+
+
    +EXAMPLE + +
    
+    Three basic ways of using silc_buffer_format:
+
+    // Statically allocated zero size buffer
+    SilcBufferStruct buffer;
+
+    memset(&buffer, 0, sizeof(buffer));
+    ret = silc_buffer_format(&buffer,
+                             SILC_STR_UI_INT(intval),
+                             SILC_STR_CHAR(charval),
+                             SILC_STR_UI_INT(intval),
+                             SILC_STR_SHORT(str_len),
+                             SILC_STR_DATA(str, str_len),
+                             SILC_STR_END);
+    if (ret < 0)
+      error;
+
+    // Free the allocated data
+    silc_buffer_purge(&buffer);
+
+    // Dynamically allocated zero size buffer
+    SilcBuffer buf;
+    buf = silc_buffer_alloc(0);
+    ret = silc_buffer_format(buf,
+                             SILC_STR_UI_INT(intval),
+                             SILC_STR_CHAR(charval),
+                             SILC_STR_END);
+    if (ret < 0)
+      error;
+
+    // Free the allocated buffer
+    silc_buffer_free(buf);
+
+    // Dynamically allocated buffer with enough space
+    SilcBuffer buf;
+    buf = silc_buffer_alloc(2 + str_len);
+    ret = silc_buffer_format(buf,
+                             SILC_STR_UI_SHORT(str_len),
+                             SILC_STR_DATA(str, str_len),
+                             SILC_STR_END);
+    if (ret < 0)
+      error;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_format_vp.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_format_vp.html new file mode 100644 index 0000000..1d8b409 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_format_vp.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_format_vp

    + + +SYNOPSIS + +
    
+    int silc_buffer_format_vp(SilcBuffer dst, va_list vp);
+
+
    +DESCRIPTION + +
    
+    Formats a buffer from a variable argument list indicated by the `ap'.
+    Returns -1 on error and the length of the formatted buffer otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_sformat.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_sformat.html new file mode 100644 index 0000000..2d8f626 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_sformat.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_sformat

    + + +SYNOPSIS + +
    
+    int silc_buffer_sformat(SilcStack stack, SilcBuffer dst, ...);
+
+
    +DESCRIPTION + +
    
+    Same as silc_buffer_format but uses `stack' to allocate the memory.
+    if `stack' is NULL reverts back to silc_buffer_format call.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_sformat_vp.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_sformat_vp.html new file mode 100644 index 0000000..db1993a --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_sformat_vp.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_sformat_vp

    + + +SYNOPSIS + +
    
+    int silc_buffer_sformat_vp(SilcStack stack, SilcBuffer dst, va_list vp);
+
+
    +DESCRIPTION + +
    
+    Same as silc_buffer_format_vp but uses `stack' to allocate the memory.
+    if `stack' is NULL reverts back to silc_buffer_format_vp call.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_sstrformat.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_sstrformat.html new file mode 100644 index 0000000..9ed582d --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_sstrformat.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_sstrformat

    + + +SYNOPSIS + +
    
+    int silc_buffer_strformat(SilcStack stack, SilcBuffer dst, ...);
+
+
    +DESCRIPTION + +
    
+    Formats a buffer from variable argument list of strings.  Each
+    string must be NULL-terminated and the variable argument list must
+    be end with SILC_STRFMT_END argument.  This allows that a string in
+    the list can be NULL, in which case it is skipped.  This automatically
+    allocates the space for the buffer data but `dst' must be already
+    allocated by the caller.  This function is equivalent to
+    silc_buffer_strformat but allocates memory from `stack'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_strformat.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_strformat.html new file mode 100644 index 0000000..7c389bf --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_strformat.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_strformat

    + + +SYNOPSIS + +
    
+    int silc_buffer_strformat(SilcBuffer dst, ...);
+
+
    +DESCRIPTION + +
    
+    Formats a buffer from variable argument list of strings.  Each
+    string must be NULL-terminated and the variable argument list must
+    be end with SILC_STRFMT_END argument.  This allows that a string in
+    the list can be NULL, in which case it is skipped.  This automatically
+    allocates the space for the buffer data but `dst' must be already
+    allocated by the caller.
+
+
    +EXAMPLE + +
    
+    ret = silc_buffer_strformat(buffer, "foo", "bar", SILC_STRFMT_END);
+    if (ret < 0)
+      error;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat.html new file mode 100644 index 0000000..e99fce1 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_sunformat

    + + +SYNOPSIS + +
    
+    int silc_buffer_sunformat(SilcStack stack, SilcBuffer src, ...);
+
+
    +DESCRIPTION + +
    
+    Same as silc_buffer_unformat but uses `stack' to allocate the memory.
+    if `stack' is NULL reverts back to silc_buffer_format call.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat_vp.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat_vp.html new file mode 100644 index 0000000..7b7608f --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_sunformat_vp.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_sunformat_vp

    + + +SYNOPSIS + +
    
+    int silc_buffer_sunformat_vp(SilcBuffer src, va_list vp);
+
+
    +DESCRIPTION + +
    
+    Same as silc_buffer_unformat_vp but uses `stack' to allocate the
+    memory.  if `stack' is NULL reverts back to silc_buffer_format_vp call.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_unformat.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_unformat.html new file mode 100644 index 0000000..501aeb0 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_unformat.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_unformat

    + + +SYNOPSIS + +
    
+    int silc_buffer_unformat(SilcBuffer src, ...);
+
+
    +DESCRIPTION + +
    
+    Unformats a buffer from a variable argument list.  Returns -1 on error
+    and the length of the unformatted buffer otherwise.
+
+
    +EXAMPLE + +
    
+    ret = silc_buffer_unformat(buffer,
+                               SILC_STR_UI_INT(&intval),
+                               SILC_STR_CHAR(&charval),
+                               SILC_STR_OFFSET(4),
+                               SILC_STR_UI16_NSTRING_ALLOC(&str, &str_len),
+                               SILC_STR_END);
+    if (ret < 0)
+      error;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt-silc_buffer_unformat_vp.html b/docs/toolkit/manual/silcbuffmt-silc_buffer_unformat_vp.html new file mode 100644 index 0000000..b9219a7 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt-silc_buffer_unformat_vp.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_buffer_unformat_vp

    + + +SYNOPSIS + +
    
+    int silc_buffer_unformat_vp(SilcBuffer src, va_list vp);
+
+
    +DESCRIPTION + +
    
+    Unformats a buffer from a variable argument list indicated by the `ap'.
+    Returns -1 on error and the length of the unformatted buffer otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Buffer Format Interface
    +SilcBufferFormatFunc
    +SilcBufferSFormatFunc
    +SilcBufferUnformatFunc
    +SilcBufferSUnformatFunc
    +silc_buffer_format
    +silc_buffer_sformat
    +silc_buffer_format_vp
    +silc_buffer_sformat_vp
    +silc_buffer_unformat
    +silc_buffer_sunformat
    +silc_buffer_unformat_vp
    +silc_buffer_sunformat_vp
    +silc_buffer_strformat
    +silc_buffer_sstrformat
    +SilcBufferParamType
    +SILC_STR_*_CHAR
    +SILC_STR_*_SHORT
    +SILC_STR_*_INT
    +SILC_STR_*_INT64
    +SILC_STR_*_STRING
    +SILC_STR_*_NSTRING
    +SILC_STR_DATA
    +SILC_STR_BUFFER
    +SILC_STR_FUNC
    +SILC_STR_OFFSET
    +SILC_STR_ADVANCE
    +SILC_STR_END
    +SILC_STRFMT_END
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt.html b/docs/toolkit/manual/silcbuffmt.html new file mode 100644 index 0000000..d150e0f --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcbuffmt.html + + + + +
    + +SILC Buffer Format Interface
    Header: silcbuffmt.h

    + + +DESCRIPTION + +
    
+ SILC Buffer Format API provides functions for formatting different data
+ types into a buffer and retrieving different data types from a buffer
+ into specified data types.  It is especially useful to format packets,
+ protocol payloads and such.
+
+ As the SilcBuffer API is not thread-safe these routines may not be used
+ in multithreaded environment with a same SilcBuffer context without
+ concurrency control.
+
+
  • SilcBufferFormatFunc +
  • SilcBufferSFormatFunc +
  • SilcBufferUnformatFunc +
  • SilcBufferSUnformatFunc +
  • silc_buffer_format +
  • silc_buffer_sformat +
  • silc_buffer_format_vp +
  • silc_buffer_sformat_vp +
  • silc_buffer_unformat +
  • silc_buffer_sunformat +
  • silc_buffer_unformat_vp +
  • silc_buffer_sunformat_vp +
  • silc_buffer_strformat +
  • silc_buffer_sstrformat +
  • SilcBufferParamType +
  • SILC_STR_*_CHAR +
  • SILC_STR_*_SHORT +
  • SILC_STR_*_INT +
  • SILC_STR_*_INT64 +
  • SILC_STR_*_STRING +
  • SILC_STR_*_NSTRING +
  • SILC_STR_DATA +
  • SILC_STR_BUFFER +
  • SILC_STR_FUNC +
  • SILC_STR_OFFSET +
  • SILC_STR_ADVANCE +
  • SILC_STR_END +
  • SILC_STRFMT_END + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcbuffmt.xref b/docs/toolkit/manual/silcbuffmt.xref new file mode 100644 index 0000000..22e6bf9 --- /dev/null +++ b/docs/toolkit/manual/silcbuffmt.xref @@ -0,0 +1,35 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcbuffmt.h" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 0 + "SILC Buffer Format Interface" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 1 + "SilcBufferFormatFunc" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "SilcBufferSFormatFunc" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "SilcBufferUnformatFunc" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "SilcBufferSUnformatFunc" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_format" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_sformat" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_format_vp" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_sformat_vp" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_unformat" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_sunformat" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_unformat_vp" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_sunformat_vp" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_strformat" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "silc_buffer_sstrformat" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 4 + "SilcBufferParamType" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_*_CHAR" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_*_SHORT" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_*_INT" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_*_INT64" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_*_STRING" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_*_NSTRING" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_DATA" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_BUFFER" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_FUNC" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_OFFSET" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_ADVANCE" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STR_END" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + "SILC_STRFMT_END" "/home/priikone/silc1/doc/toolkit/silcbuffmt.html" 8 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcchannel-SilcChannelKeyPayload.html b/docs/toolkit/manual/silcchannel-SilcChannelKeyPayload.html new file mode 100644 index 0000000..1b02ab4 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-SilcChannelKeyPayload.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcChannelKeyPayload

    + + +NAME + +
    
+    typedef struct SilcChannelKeyPayloadStruct *SilcChannelKeyPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Channel Key Payload and is allocated
+    by silc_channel_key_payload_parse and given as argument usually to
+    all silc_channel_key_payload_* functions.  It is freed by the
+    silc_channel_key_payload_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-SilcChannelPayload.html b/docs/toolkit/manual/silcchannel-SilcChannelPayload.html new file mode 100644 index 0000000..17d8dfe --- /dev/null +++ b/docs/toolkit/manual/silcchannel-SilcChannelPayload.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcChannelPayload

    + + +NAME + +
    
+    typedef struct SilcChannelPayloadStruct *SilcChannelPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Channel Payload and is allocated
+    by silc_channel_payload_parse and given as argument usually to
+    all silc_channel_payload_* functions.  It is freed by the
+    silc_channel_payload_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_get_id.html b/docs/toolkit/manual/silcchannel-silc_channel_get_id.html new file mode 100644 index 0000000..bac2786 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_get_id.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_get_id

    + + +SYNOPSIS + +
    
+    unsigned char *silc_channel_get_id(SilcChannelPayload payload,
+                                       SilcUInt32 *channel_id_len);
+
+
    +DESCRIPTION + +
    
+    Return the Channel ID data from the payload. The caller must not free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_get_id_parse.html b/docs/toolkit/manual/silcchannel-silc_channel_get_id_parse.html new file mode 100644 index 0000000..100c4f4 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_get_id_parse.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_get_id_parse

    + + +SYNOPSIS + +
    
+    SilcBool silc_channel_get_id_parse(SilcChannelPayload payload,
+                                       SilcChannelID *ret_channel_id);
+
+
    +DESCRIPTION + +
    
+    Return the Channel ID as parsed ID. This is equivalent to the
+    silc_channel_get_id execpt that the ID is already parsed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_get_mode.html b/docs/toolkit/manual/silcchannel-silc_channel_get_mode.html new file mode 100644 index 0000000..d8ff127 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_get_mode.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_get_mode

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_channel_get_mode(SilcChannelPayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the mode. The mode is arbitrary. It can be the mode of the
+    channel or perhaps the mode of the client on the channel.  The protocol
+    dictates what the usage of the mode is in different circumstances.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_get_name.html b/docs/toolkit/manual/silcchannel-silc_channel_get_name.html new file mode 100644 index 0000000..35268b2 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_get_name.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_get_name

    + + +SYNOPSIS + +
    
+    unsigned char *silc_channel_get_name(SilcChannelPayload payload,
+                                         SilcUInt32 *channel_name_len);
+
+
    +DESCRIPTION + +
    
+    Return the channel name from the payload. The caller must not free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_key_get_cipher.html b/docs/toolkit/manual/silcchannel-silc_channel_key_get_cipher.html new file mode 100644 index 0000000..ac65223 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_key_get_cipher.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_key_get_cipher

    + + +SYNOPSIS + +
    
+    unsigned char *silc_channel_key_get_cipher(SilcChannelKeyPayload payload,
+                                               SilcUInt32 *cipher_len);
+
+
    +DESCRIPTION + +
    
+    Return the name of the cipher from the payload. The caller must not
+    free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_key_get_id.html b/docs/toolkit/manual/silcchannel-silc_channel_key_get_id.html new file mode 100644 index 0000000..de4fbb9 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_key_get_id.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_key_get_id

    + + +SYNOPSIS + +
    
+    unsigned char *silc_channel_key_get_id(SilcChannelKeyPayload payload,
+                                           SilcUInt32 *id_len);
+
+
    +DESCRIPTION + +
    
+    Return the Channel ID data from the payload. The caller must not
+    free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_key_get_key.html b/docs/toolkit/manual/silcchannel-silc_channel_key_get_key.html new file mode 100644 index 0000000..5d920a7 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_key_get_key.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_key_get_key

    + + +SYNOPSIS + +
    
+    unsigned char *silc_channel_key_get_key(SilcChannelKeyPayload payload,
+                                            SilcUInt32 *key_len);
+
+
    +DESCRIPTION + +
    
+    Return the raw key material from the payload. The caller must not
+    free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_key_payload_encode.html b/docs/toolkit/manual/silcchannel-silc_channel_key_payload_encode.html new file mode 100644 index 0000000..3c4959a --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_key_payload_encode.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_key_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_channel_key_payload_encode(SilcUInt16 id_len,
+                                               const unsigned char *id,
+                                               SilcUInt16 cipher_len,
+                                               const unsigned char *cipher,
+                                               SilcUInt16 key_len,
+                                               const unsigned char *key);
+
+
    +DESCRIPTION + +
    
+    Encodes channel key payload into a buffer and returns it. This is used
+    to add channel key payload into a packet.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_key_payload_free.html b/docs/toolkit/manual/silcchannel-silc_channel_key_payload_free.html new file mode 100644 index 0000000..04a187d --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_key_payload_free.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_key_payload_free

    + + +SYNOPSIS + +
    
+    void silc_channel_key_payload_free(SilcChannelKeyPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Channel Key Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_key_payload_parse.html b/docs/toolkit/manual/silcchannel-silc_channel_key_payload_parse.html new file mode 100644 index 0000000..81e1515 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_key_payload_parse.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_key_payload_parse

    + + +SYNOPSIS + +
    
+    SilcChannelKeyPayload
+    silc_channel_key_payload_parse(const unsigned char *payload,
+                                   uin32 payload_len);
+
+
    +DESCRIPTION + +
    
+     Parses channel key payload returning new channel key payload
+     structure.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_payload_encode.html b/docs/toolkit/manual/silcchannel-silc_channel_payload_encode.html new file mode 100644 index 0000000..5fc4e65 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_payload_encode.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_channel_payload_encode(const unsigned char *channel_name,
+                                           SilcUInt16 channel_name_len,
+                                           const unsigned char *channel_id,
+                                           SilcUInt32 channel_id_len,
+                                           SilcUInt32 mode);
+
+
    +DESCRIPTION + +
    
+    Encode new channel payload and returns it as buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_payload_free.html b/docs/toolkit/manual/silcchannel-silc_channel_payload_free.html new file mode 100644 index 0000000..b229465 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_payload_free.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_payload_free

    + + +SYNOPSIS + +
    
+    void silc_channel_payload_free(SilcChannelPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees Channel Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_payload_list_free.html b/docs/toolkit/manual/silcchannel-silc_channel_payload_list_free.html new file mode 100644 index 0000000..accf299 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_payload_list_free.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_payload_list_free

    + + +SYNOPSIS + +
    
+    void silc_channel_payload_list_free(SilcDList list);
+
+
    +DESCRIPTION + +
    
+    Frees list of Channel Payloads and all data in them.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_payload_parse.html b/docs/toolkit/manual/silcchannel-silc_channel_payload_parse.html new file mode 100644 index 0000000..c714960 --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_payload_parse.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_payload_parse

    + + +SYNOPSIS + +
    
+    SilcChannelPayload
+    silc_channel_payload_parse(const unsigned char *payload,
+                               SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parses channel payload returning new channel payload structure. The
+    `buffer' is the raw payload buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel-silc_channel_payload_parse_list.html b/docs/toolkit/manual/silcchannel-silc_channel_payload_parse_list.html new file mode 100644 index 0000000..5faaadb --- /dev/null +++ b/docs/toolkit/manual/silcchannel-silc_channel_payload_parse_list.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_channel_payload_parse_list

    + + +SYNOPSIS + +
    
+    SilcDList
+    silc_channel_payload_parse_list(const unsigned char *payload,
+                                    SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parses list of channel payloads returning list of payloads. This
+    is equivalent to the silc_channel_payload_parse except that the `buffer'
+    now includes multiple Channel Payloads one after the other.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Channel Interface
    +SilcChannelPayload
    +SilcChannelKeyPayload
    +silc_channel_payload_parse
    +silc_channel_payload_parse_list
    +silc_channel_payload_encode
    +silc_channel_payload_free
    +silc_channel_payload_list_free
    +silc_channel_get_name
    +silc_channel_get_id
    +silc_channel_get_id_parse
    +silc_channel_get_mode
    +silc_channel_key_payload_parse
    +silc_channel_key_payload_encode
    +silc_channel_key_payload_free
    +silc_channel_key_get_id
    +silc_channel_key_get_cipher
    +silc_channel_key_get_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel.html b/docs/toolkit/manual/silcchannel.html new file mode 100644 index 0000000..5412a8a --- /dev/null +++ b/docs/toolkit/manual/silcchannel.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcchannel.html + + + + +
    + +SILC Channel Interface
    Header: silcchannel.h

    + + +DESCRIPTION + +
    
+ Implementations of the Channel Payload and Channel Key Payload.  The
+ Channel Payload represents new channel and is used to distribute the
+ information of the new channel.  The Channel Key Payload is used to
+ distribute a new key to the channel.  It is done for example every
+ time someone joins a channel or the old key expires.
+
+
  • SilcChannelPayload +
  • SilcChannelKeyPayload +
  • silc_channel_payload_parse +
  • silc_channel_payload_parse_list +
  • silc_channel_payload_encode +
  • silc_channel_payload_free +
  • silc_channel_payload_list_free +
  • silc_channel_get_name +
  • silc_channel_get_id +
  • silc_channel_get_id_parse +
  • silc_channel_get_mode +
  • silc_channel_key_payload_parse +
  • silc_channel_key_payload_encode +
  • silc_channel_key_payload_free +
  • silc_channel_key_get_id +
  • silc_channel_key_get_cipher +
  • silc_channel_key_get_key + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcchannel.xref b/docs/toolkit/manual/silcchannel.xref new file mode 100644 index 0000000..f3c4526 --- /dev/null +++ b/docs/toolkit/manual/silcchannel.xref @@ -0,0 +1,24 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcchannel.h" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 0 + "SILC Channel Interface" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 1 + "SilcChannelPayload" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 5 + "SilcChannelKeyPayload" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 5 + "silc_channel_payload_parse" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_payload_parse_list" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_payload_encode" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_payload_free" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_payload_list_free" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_get_name" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_get_id" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_get_id_parse" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_get_mode" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_key_payload_parse" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_key_payload_encode" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_key_payload_free" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_key_get_id" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_key_get_cipher" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + "silc_channel_key_get_key" "/home/priikone/silc1/doc/toolkit/silcchannel.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silccipher-SilcCipher.html b/docs/toolkit/manual/silccipher-SilcCipher.html new file mode 100644 index 0000000..edf04f1 --- /dev/null +++ b/docs/toolkit/manual/silccipher-SilcCipher.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcCipher

    + + +NAME + +
    
+    typedef struct { ... } SilcCipher;
+
+
    +DESCRIPTION + +
    
+    This context is the actual cipher context and is allocated
+    by silc_cipher_alloc and given as argument usually to all
+    silc_cipher _* functions.  It is freed by the silc_cipher_free
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-SilcCipherMode.html b/docs/toolkit/manual/silccipher-SilcCipherMode.html new file mode 100644 index 0000000..29d8a15 --- /dev/null +++ b/docs/toolkit/manual/silccipher-SilcCipherMode.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcCipherMode

    + + +NAME + +
    
+    typedef enum { ... } SilcCipherMode;
+
+
    +DESCRIPTION + +
    
+    Cipher modes.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CIPHER_MODE_ECB = 1,     /* ECB mode */
+      SILC_CIPHER_MODE_CBC = 2,     /* CBC mode */
+      SILC_CIPHER_MODE_CTR = 3,     /* CTR mode */
+      SILC_CIPHER_MODE_CFB = 4,     /* CFB mode */
+      SILC_CIPHER_MODE_OFB = 5,     /* OFB mode */
+    } SilcCipherMode;
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_alloc.html b/docs/toolkit/manual/silccipher-silc_cipher_alloc.html new file mode 100644 index 0000000..ae389ea --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_alloc.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_alloc(const unsigned char *name,
+                               SilcCipher *new_cipher);
+
+
    +DESCRIPTION + +
    
+    Allocates a new SILC cipher object. Function returns 1 on succes and 0
+    on error. The allocated cipher is returned in new_cipher argument. The
+    caller must set the key to the cipher after this function has returned
+    by calling the ciphers set_key function.
+
+    The following ciphers are supported:
+
+    aes-256-ctr            AES-256, Counter mode
+    aes-192-ctr            AES-192, Counter mode
+    aes-128-ctr            AES,128, Counter mode
+    aes-256-cbc            AES-256, Cipher block chaining mode
+    aes-192-cbc            AES-192, Cipher block chaining mode
+    aes-128-cbc            AES,128, Cipher block chaining mode
+    twofish-256-cbc        Twofish-256, Cipher block chaining mode
+    twofish-192-cbc        Twofish-192, Cipher block chaining mode
+    twofish-128-cbc        Twofish-128, Cipher block chaining mode
+
+    Notes about modes:
+
+    The CTR is normal counter mode.  The CTR mode does not require the
+    plaintext length to be multiple by the cipher block size.  If the last
+    plaintext block is shorter the remaining bits of the key stream are
+    used next time silc_cipher_encrypt is called.  If silc_cipher_set_iv
+    is called it will reset the counter for a new block (discarding any
+    remaining bits from previous key stream).
+
+    The CBC is mode is a standard CBC mode.  The plaintext length must be
+    multiple by the cipher block size.  If it isn't the plaintext must be
+    padded.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_decrypt.html b/docs/toolkit/manual/silccipher-silc_cipher_decrypt.html new file mode 100644 index 0000000..ec63011 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_decrypt.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_decrypt

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_decrypt(SilcCipher cipher,
+                                 const unsigned char *src,
+                                 unsigned char *dst, SilcUInt32 len,
+                                 unsigned char *iv);
+
+
    +DESCRIPTION + +
    
+    Decrypts data from `src' into `dst' with the specified cipher and
+    Initial Vector (IV).  If the `iv' is NULL then the cipher's internal
+    IV is used.  The `src' and `dst' maybe same buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_encrypt.html b/docs/toolkit/manual/silccipher-silc_cipher_encrypt.html new file mode 100644 index 0000000..d3f1776 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_encrypt.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_encrypt

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_encrypt(SilcCipher cipher,
+                                 const unsigned char *src,
+                                 unsigned char *dst, SilcUInt32 len,
+                                 unsigned char *iv);
+
+
    +DESCRIPTION + +
    
+    Encrypts data from `src' into `dst' with the specified cipher and
+    Initial Vector (IV).  If the `iv' is NULL then the cipher's internal
+    IV is used.  The `src' and `dst' maybe same buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_free.html b/docs/toolkit/manual/silccipher-silc_cipher_free.html new file mode 100644 index 0000000..9069a45 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_free.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_free

    + + +SYNOPSIS + +
    
+    void silc_cipher_free(SilcCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Frees the given cipher.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_get_block_len.html b/docs/toolkit/manual/silccipher-silc_cipher_get_block_len.html new file mode 100644 index 0000000..3513ef5 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_get_block_len.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_get_block_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_cipher_get_block_len(SilcCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Returns the block size of the cipher in bytes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_get_iv.html b/docs/toolkit/manual/silccipher-silc_cipher_get_iv.html new file mode 100644 index 0000000..1e57525 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_get_iv.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_get_iv

    + + +SYNOPSIS + +
    
+    unsigned char *silc_cipher_get_iv(SilcCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Returns the IV (initial vector) of the cipher.  The returned
+    pointer must not be freed by the caller.  If the caller modifies
+    the returned pointer the IV inside cipher is also modified.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_get_iv_len.html b/docs/toolkit/manual/silccipher-silc_cipher_get_iv_len.html new file mode 100644 index 0000000..1dfe36f --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_get_iv_len.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_get_iv_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_cipher_get_iv_len(SilcCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Returns the IV length of the cipher in bytes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_get_key_len.html b/docs/toolkit/manual/silccipher-silc_cipher_get_key_len.html new file mode 100644 index 0000000..811d8ed --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_get_key_len.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_get_key_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_cipher_get_key_len(SilcCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Returns the key length of the cipher in bits.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_get_mode.html b/docs/toolkit/manual/silccipher-silc_cipher_get_mode.html new file mode 100644 index 0000000..5e43bbc --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_get_mode.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_get_mode

    + + +SYNOPSIS + +
    
+    SilcCipherMode silc_cipher_get_mode(SilcCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Returns the cipher mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_get_name.html b/docs/toolkit/manual/silccipher-silc_cipher_get_name.html new file mode 100644 index 0000000..89a18f0 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_get_name.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_get_name

    + + +SYNOPSIS + +
    
+    const char *silc_cipher_get_name(SilcCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Returns the name of the cipher.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_get_supported.html b/docs/toolkit/manual/silccipher-silc_cipher_get_supported.html new file mode 100644 index 0000000..4fa0f87 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_get_supported.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_get_supported

    + + +SYNOPSIS + +
    
+    char *silc_cipher_get_supported(void);
+
+
    +DESCRIPTION + +
    
+    Returns comma separated list of supported ciphers.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_is_supported.html b/docs/toolkit/manual/silccipher-silc_cipher_is_supported.html new file mode 100644 index 0000000..6707e0a --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_is_supported.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_is_supported

    + + +SYNOPSIS + +
    
+ SilcBool silc_cipher_is_supported(const unsigned char *name);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if cipher `name' is supported.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_register.html b/docs/toolkit/manual/silccipher-silc_cipher_register.html new file mode 100644 index 0000000..f6cfed4 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_register.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_register

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_register(const SilcCipherObject *cipher);
+
+
    +DESCRIPTION + +
    
+    Register a new cipher into SILC. This is used at the initialization of
+    the SILC. This function allocates a new object for the cipher to be
+    registered. Therefore, if memory has been allocated for the object sent
+    as argument it has to be free'd after this function returns succesfully.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_register_default.html b/docs/toolkit/manual/silccipher-silc_cipher_register_default.html new file mode 100644 index 0000000..6ecfe62 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_register_default.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_register_default

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_register_default(void);
+
+
    +DESCRIPTION + +
    
+    Function that registers all the default ciphers (all builtin ciphers).
+    The application may use this to register the default ciphers if specific
+    ciphers in any specific order is not wanted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_set_iv.html b/docs/toolkit/manual/silccipher-silc_cipher_set_iv.html new file mode 100644 index 0000000..fc7a3ea --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_set_iv.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_set_iv

    + + +SYNOPSIS + +
    
+    void silc_cipher_set_iv(SilcCipher cipher, const unsigned char *iv);
+
+
    +DESCRIPTION + +
    
+    Sets the IV (initial vector) for the cipher.  The `iv' must be
+    the size of the block size of the cipher.  If `iv' is NULL this
+    does not do anything.
+
+    If the encryption mode is CTR (Counter mode) this also resets the
+    the counter for a new block.  This is done also if `iv' is NULL.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_set_key.html b/docs/toolkit/manual/silccipher-silc_cipher_set_key.html new file mode 100644 index 0000000..2e9100f --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_set_key.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_set_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_set_key(SilcCipher cipher, const unsigned char *key,
+                                 SilcUInt32 keylen, SilcBool encryption);
+
+
    +DESCRIPTION + +
    
+    Sets the key for the cipher.  The `keylen' is the key length in
+    bits.  If the `encryption' is TRUE the key is for encryption, if FALSE
+    the key is for decryption.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_unregister.html b/docs/toolkit/manual/silccipher-silc_cipher_unregister.html new file mode 100644 index 0000000..15a1449 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_unregister.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_unregister

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_unregister(SilcCipherObject *cipher);
+
+
    +DESCRIPTION + +
    
+    Unregister a cipher from the SILC.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher-silc_cipher_unregister_all.html b/docs/toolkit/manual/silccipher-silc_cipher_unregister_all.html new file mode 100644 index 0000000..a296675 --- /dev/null +++ b/docs/toolkit/manual/silccipher-silc_cipher_unregister_all.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_cipher_unregister_all

    + + +SYNOPSIS + +
    
+    SilcBool silc_cipher_unregister_all(void);
+
+
    +DESCRIPTION + +
    
+    Unregisters all ciphers.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Cipher Interface
    +SilcCipher
    +SilcCipherMode
    +silc_cipher_register
    +silc_cipher_unregister
    +silc_cipher_register_default
    +silc_cipher_unregister_all
    +silc_cipher_alloc
    +silc_cipher_free
    +silc_cipher_is_supported
    +silc_cipher_get_supported
    +silc_cipher_encrypt
    +silc_cipher_decrypt
    +silc_cipher_set_key
    +silc_cipher_set_iv
    +silc_cipher_get_iv
    +silc_cipher_get_key_len
    +silc_cipher_get_block_len
    +silc_cipher_get_iv_len
    +silc_cipher_get_name
    +silc_cipher_get_mode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher.html b/docs/toolkit/manual/silccipher.html new file mode 100644 index 0000000..0438319 --- /dev/null +++ b/docs/toolkit/manual/silccipher.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silccipher.html + + + + +
    + +SILC Cipher Interface
    Header: silccipher.h

    + + +DESCRIPTION + +
    
+ This is the interface for cipher functions.  It provides cipher
+ registering and unregistering routines, encryption and decryption
+ routines.
+
+
  • SilcCipher +
  • SilcCipherMode +
  • silc_cipher_register +
  • silc_cipher_unregister +
  • silc_cipher_register_default +
  • silc_cipher_unregister_all +
  • silc_cipher_alloc +
  • silc_cipher_free +
  • silc_cipher_is_supported +
  • silc_cipher_get_supported +
  • silc_cipher_encrypt +
  • silc_cipher_decrypt +
  • silc_cipher_set_key +
  • silc_cipher_set_iv +
  • silc_cipher_get_iv +
  • silc_cipher_get_key_len +
  • silc_cipher_get_block_len +
  • silc_cipher_get_iv_len +
  • silc_cipher_get_name +
  • silc_cipher_get_mode + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccipher.xref b/docs/toolkit/manual/silccipher.xref new file mode 100644 index 0000000..9d68977 --- /dev/null +++ b/docs/toolkit/manual/silccipher.xref @@ -0,0 +1,27 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silccipher.h" "/home/priikone/silc1/doc/toolkit/silccipher.html" 0 + "SILC Cipher Interface" "/home/priikone/silc1/doc/toolkit/silccipher.html" 1 + "SilcCipher" "/home/priikone/silc1/doc/toolkit/silccipher.html" 5 + "SilcCipherMode" "/home/priikone/silc1/doc/toolkit/silccipher.html" 8 + "silc_cipher_register" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_unregister" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_register_default" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_unregister_all" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_alloc" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_free" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_is_supported" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_get_supported" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_encrypt" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_decrypt" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_set_key" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_set_iv" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_get_iv" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_get_key_len" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_get_block_len" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_get_iv_len" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_get_name" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + "silc_cipher_get_mode" "/home/priikone/silc1/doc/toolkit/silccipher.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcclient-SilcAskPassphrase.html b/docs/toolkit/manual/silcclient-SilcAskPassphrase.html new file mode 100644 index 0000000..7802dc3 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcAskPassphrase.html @@ -0,0 +1,286 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcAskPassphrase

    + + +SYNOPSIS + +
    
+    typedef void (*SilcAskPassphrase)(const unsigned char *passphrase,
+                                        SilcUInt32 passphrase_len,
+                                        void *context);
+
+
    +DESCRIPTION + +
    
+    Ask passphrase callback. This is called by the application when the
+    library calls `ask_passphrase' client operation.  The callback delivers
+    the passphrase to the library.  The passphrases in SILC protocol
+    MUST be in UTF-8 encoding, therefore the `passphrase' SHOULD be UTF-8
+    encoded, and if it is not then library will attempt to encode it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcChannelPrivateKey.html b/docs/toolkit/manual/silcclient-SilcChannelPrivateKey.html new file mode 100644 index 0000000..175a25c --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcChannelPrivateKey.html @@ -0,0 +1,290 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcChannelPrivateKey

    + + +NAME + +
    
+    typedef struct SilcChannelPrivateKeyStruct { ... }
+                      *SilcChannelPrivateKey;
+
+
    +DESCRIPTION + +
    
+    Structure to hold one channel private key. The array of this structure
+    is returned by silc_client_list_channel_private_keys function.
+
+
    +SOURCE + +
        struct SilcChannelPrivateKeyStruct {
+      char *name;                         /* Application given name */
+      SilcCipher send_key;                /* The cipher and key */
+      SilcCipher receive_key;             /* The cipher and key */
+      SilcHmac hmac;                      /* The HMAC and hmac key */
+    };
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcChannelUser.html b/docs/toolkit/manual/silcclient-SilcChannelUser.html new file mode 100644 index 0000000..83c9572 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcChannelUser.html @@ -0,0 +1,292 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcChannelUser

    + + +NAME + +
    
+    typedef struct SilcChannelUserStruct { ... } *SilcChannelUser
+
+
    +DESCRIPTION + +
    
+    This structure represents a client that has joined to a channel.
+    It shows the client and the channel and the client's mode (channel
+    user mode) on the channel.
+
+
    +SOURCE + +
        struct SilcChannelUserStruct {
+      SilcClientEntry client;                    /* Client joined on channel */
+      SilcUInt32 mode;                           /* mode, ChannelUserModes */
+      SilcChannelEntry channel;                  /* The channel user has joined */
+    
+      /* Application specific data.  Application may set here whatever it wants. */
+      void *context;
+    };
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClient.html b/docs/toolkit/manual/silcclient-SilcClient.html new file mode 100644 index 0000000..f2b9a43 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClient.html @@ -0,0 +1,301 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClient

    + + +NAME + +
    
+    typedef struct SilcClientStruct { ... } *SilcClient
+
+
    +DESCRIPTION + +
    
+    This is the actual SILC Client structure which represents one
+    SILC Client.  It is allocated with the silc_client_alloc function
+    and given as argument to all SILC Client Library functions.  It
+    is initialized with silc_client_init function, and freed with
+    silc_client_free function.
+
+    This context represents the client.  Each connection to remote server
+    is represented by SilcClientConnection context.
+
+
    +SOURCE + +
        struct SilcClientStruct {
+      char *username;               /* Username */
+      char *hostname;               /* hostname */
+      char *realname;               /* Real name */
+      SilcSchedule schedule;        /* Client scheduler */
+      SilcRng rng;                  /* Random number generator */
+      void *application;            /* Application specific context, set with
+                                       silc_client_alloc. */
+    
+      /* Internal data for client library.  Application cannot access this. */
+      SilcClientInternal internal;
+    };
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientCommandReply.html b/docs/toolkit/manual/silcclient-SilcClientCommandReply.html new file mode 100644 index 0000000..db5e90c --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientCommandReply.html @@ -0,0 +1,303 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcClientCommandReply

    + + +SYNOPSIS + +
    
+    typedef SilcBool (*SilcClientCommandReply)(SilcClient client,
+                                               SilcClientConnection conn,
+                                               SilcCommand command,
+                                               SilcStatus status,
+                                               SilcStatus error,
+                                               void *context,
+                                               va_list ap);
+
+
    +DESCRIPTION + +
    
+    The command reply callback function given as argument to functions
+    silc_client_command_send and silc_client_command_pending.  This is
+    called to deliver the command replies to the caller.  Each command
+    reply received from the server to the `command' will be delivered
+    separately to the caller by calling this callback.  The `status' will
+    indicate whether there is only one reply or multiple replies.  The
+    `error' will indicate if an error occurred.  The `ap' will include
+    command reply arguments.  They are the same arguments as for
+    `command_reply' client operation callback in SilcClientOperations.
+
+    If `status' is SILC_STATUS_OK only one reply was received and error
+    did not occur.  If it is SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
+    or SILC_STATUS_LIST_END, there are will be two or more replies.  The
+    first reply is SILC_STATUS_LIST_START and last one SILC_STATUS_LIST_END.
+
+    If FALSE is returned in this function this callback will not be called
+    again for `command' even if there are more comand replies.  By returning
+    FALSE the caller my stop the command reply handling when needed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientConnectCallback.html b/docs/toolkit/manual/silcclient-SilcClientConnectCallback.html new file mode 100644 index 0000000..914fdec --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientConnectCallback.html @@ -0,0 +1,304 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcClientConnectCallback

    + + +SYNOPSIS + +
    
+    void (*SilcClientConnectCallback)(SilcClient client,
+                                      SilcClientConnection conn,
+                                      SilcClientConnectionStatus status,
+                                      SilcStatus error,
+                                      const char *message,
+                                      void *context);
+
+
    +DESCRIPTION + +
    
+    Connect callbak given as argument to silc_client_connect_to_server,
+    silc_client_connect_to_client and silc_client_key_exchange functions.
+    It is called to indicate the status of the connection, indicated
+    by the `status'.  It is called after the connection has been
+    established to the remote host and when connection is disconnected
+    by the remote host.  The `context' is the context given as argument
+    to the connecting function.  If the `status' is an error the `error'
+    may indicate more detailed error.  If `error' is SILC_STATUS_OK no
+    detailed error message is available.
+
+    When the `status' is SILC_CLIENT_CONN_DISCONNECTED the `error' will
+    indicate the reason for disconnection.  If the `message' is non-NULL
+    it delivers error or disconnection message.
+
+    The `conn' is the connection to the remote host.  In case error
+    occurred the `conn' may be NULL, however, in some cases a valid `conn'
+    is returned even in error.  If `conn' is non-NULL the receiver is
+    responsible of closing the connection with silc_client_close_connection
+    function, except when SILC_CLINET_CONN_DISCONNECTED or some error
+    was received.  In these cases the library will close the connection.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientConnection.html b/docs/toolkit/manual/silcclient-SilcClientConnection.html new file mode 100644 index 0000000..b793730 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientConnection.html @@ -0,0 +1,322 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClientConnection

    + + +NAME + +
    
+    typedef struct SilcClientConnectionStruct { ... }
+                      *SilcClientConnection
+
+
    +DESCRIPTION + +
    
+    This structure represents a connection.  It is allocated and freed by
+    the library.  It is returned to application in SilcClientConnectCallback.
+    It includes all the important data for the session such as local
+    client entry (which includes current nickname), local and remote IDs,
+    and other information.  All strings in the structure are UTF-8 encoded.
+
+
    +SOURCE + +
        struct SilcClientConnectionStruct {
+      SilcClientEntry local_entry;         /* Our own Client Entry */
+      SilcClientID *local_id;              /* Our current Client ID */
+    
+      char *remote_host;                   /* Remote host name */
+      int remote_port;                     /* Remote port */
+      SilcID remote_id;                    /* Remote ID */
+    
+      SilcChannelEntry current_channel;    /* Current joined channel */
+      SilcPublicKey public_key;            /* Public key used in this connection */
+      SilcPrivateKey private_key;          /* Private key */
+      SilcPacketStream stream;             /* Connection to remote host */
+      SilcConnectionType type;             /* Connection type */
+      SilcClientConnectCallback callback;  /* Connection callback */
+      void *callback_context;              /* Connection context */
+      SilcClient client;                   /* Pointer back to SilcClient */
+    
+      /* Current say() operation associated context, identifies the client,
+         channel or server the message is related to.  Application can use
+         this information to target the message better. */
+      union {
+        SilcClientEntry client_entry;
+        SilcChannelEntry channel_entry;
+        SilcServerEntry server_entry;
+      };
+      SilcIdType context_type;              /* Defines which pointer is set
+                                               in the union.  If SILC_ID_NONE
+                                               pointer is NULL. */
+    
+      /* Application specific data.  Application may set here whatever it wants. */
+      void *context;
+    
+      /* Internal data for client library.  Application cannot access this. */
+      SilcClientConnectionInternal internal;
+    };
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientConnectionParams.html b/docs/toolkit/manual/silcclient-SilcClientConnectionParams.html new file mode 100644 index 0000000..59f1a6f --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientConnectionParams.html @@ -0,0 +1,377 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClientConnectionParams

    + + +NAME + +
    
+    typedef struct { ... } SilcClientConnectionParams;
+
+
    +DESCRIPTION + +
    
+    Client connection parameters.  This can be filled by the application
+    and given as argument to silc_client_connect_to_server,
+    silc_client_connect_to_client, silc_client_key_exchange or
+    silc_client_send_key_agreement.
+
+
    +SOURCE + +
        typedef struct SilcClientConnectionParamsStruct {
+      /* If this is provided the user's nickname in the network will be the
+         string given here.  If it is given, it must be UTF-8 encoded.  If this
+         string is not given, the user's username by default is used as nickname.
+         The nickname may later be changed by using NICK command.  The maximum
+         length for the nickname string is 128 bytes. */
+      char *nickname;
+    
+      /* If this key repository pointer is non-NULL then public key received in
+         the key exchange protocol will be verified from this repository.  If
+         this is not provided then the `verify_public_key' client operation will
+         be called back to application.  If the boolean `verify_notfound' is set
+         to TRUE then the `verify_public_key' client operation will be called
+         in case the public key is not found in `repository'.  Only public keys
+         added with at least SILC_SKR_USAGE_KEY_AGREEMENT in the repository will
+         be checked, other keys will be ignored. */
+      SilcSKR repository;
+      SilcBool verify_notfound;
+    
+      /* Authentication data.  Application may set here the authentication data
+         and authentication method to be used in connecting.  If `auth_set'
+         boolean is TRUE then authentication data is provided by application.
+         If the authentication method is public key authentication then the key
+         pair given as argument when connecting will be used and `auth' field
+         is NULL.  If it is passphrase authentication, it can be provided in
+         `auth' and `auth_len' fields.  If `auth_set' is FALSE
+         the `get_auth_method' client operation will be called to get the
+         authentication method and data from application. */
+      SilcBool auth_set;
+      SilcAuthMethod auth_method;
+      void *auth;
+      SilcUInt32 auth_len;
+    
+      /* If this boolean is set to TRUE then the connection will use UDP instead
+         of TCP.  If UDP is set then also the next `local_ip' and `local_port'
+         must be set. */
+      SilcBool udp;
+    
+      /* The `local_ip' specifies the local IP address used with the connection.
+         It must be non-NULL if `udp' boolean is TRUE.  If the `local_port' is
+         non-zero it will be used as local port with UDP connection.  The remote
+         host will also send packets to the specified address and port.  If the
+         `bind_ip' is non-NULL a listener is bound to that address instead of
+         `local_ip'. */
+      char *local_ip;
+      char *bind_ip;
+      int local_port;
+    
+      /* If this boolean is set to TRUE then the key exchange is done with
+         perfect forward secrecy. */
+      SilcBool pfs;
+    
+      /* If this boolean is set to TRUE then connection authentication protocol
+         is not performed during connecting.  Only key exchange protocol is
+         performed.  This usually must be set to TRUE when connecting to another
+         client, but must be FALSE with server connections. */
+      SilcBool no_authentication;
+    
+      /* The SILC session detachment data that was returned in the `command_reply'
+         client operation for SILC_COMMAND_DETACH command.  If this is provided
+         here the client library will attempt to resume the session in the network.
+         After the connection is created and the session has been resumed the
+         client will receive SILC_COMMAND_NICK command_reply for the client's
+         nickname in the network and SILC_COMMAND_JOIN command reply for all the
+         channels that the client has joined in the network.  It may also receive
+         SILC_COMMAND_UMODE command reply to set user's mode on the network. */
+      unsigned char *detach_data;
+      SilcUInt32 detach_data_len;
+    
+      /* Connection timeout.  If non-zero, the connection will timeout unless
+         the SILC connection is completed in the specified amount of time. */
+      SilcUInt32 timeout_secs;
+    
+      /* Rekey timeout in seconds.  The client will perform rekey in this
+         time interval.  If set to zero, the default value will be used
+         (3600 seconds, 1 hour). */
+      SilcUInt32 rekey_secs;
+    
+      /* If this is set to TRUE then the client will ignore all incoming
+         Requested Attributes queries and does not reply anything back.  This
+         usually leads into situation where server does not anymore send
+         the queries after seeing that client does not reply anything back.
+         If your application does not support Requested Attributes or you do
+         not want to use them set this to TRUE.  See SilcAttribute and
+         silc_client_attribute_add for more information on attributes. */
+      SilcBool ignore_requested_attributes;
+    
+      /* User context for SilcClientConnection.  If non-NULL this context is
+         set to the 'context' field in SilcClientConnection when the connection
+         context is created. */
+      void *context;
+    } SilcClientConnectionParams;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientConnectionStatus.html b/docs/toolkit/manual/silcclient-SilcClientConnectionStatus.html new file mode 100644 index 0000000..1a33a31 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientConnectionStatus.html @@ -0,0 +1,295 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcClientConnectionStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcClientConnectionStatus
+
+
    +DESCRIPTION + +
    
+    This type is returned to the `connect' client operation to indicate
+    the status of the created connection.  It can indicate if it was
+    successful or whether an error occurred.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CLIENT_CONN_SUCCESS,            /* Successfully connected */
+      SILC_CLIENT_CONN_SUCCESS_RESUME,     /* Successfully connected and
+                                              resumed old detached session */
+      SILC_CLIENT_CONN_DISCONNECTED,       /* Remote host disconnected */
+      SILC_CLIENT_CONN_ERROR,              /* Error occurred during connecting */
+      SILC_CLIENT_CONN_ERROR_KE,           /* Key Exchange failed */
+      SILC_CLIENT_CONN_ERROR_AUTH,         /* Authentication failed */
+      SILC_CLIENT_CONN_ERROR_RESUME,       /* Resuming failed */
+      SILC_CLIENT_CONN_ERROR_TIMEOUT,      /* Timeout during connecting */
+    } SilcClientConnectionStatus;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientFileAskName.html b/docs/toolkit/manual/silcclient-SilcClientFileAskName.html new file mode 100644 index 0000000..4ec4600 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientFileAskName.html @@ -0,0 +1,292 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcClientFileAskName

    + + +SYNOPSIS + +
    
+    typedef void (*SilcClientFileAskName)(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcUInt32 session_id,
+                                          const char *remote_filename,
+                                          SilcClientFileName completion,
+                                          void *completion_context,
+                                          void *context);
+
+
    +DESCRIPTION + +
    
+    File name asking callback that is called if it is given to the
+    silc_client_file_receive and the path given to that as argument was
+    NULL.  The library calls this to ask the filename and filepath to
+    where the file is to be saved.  The 'remote_filename' is the file
+    that is being downloaded.  Application must call the 'completion'
+    with 'completion_context' to continue with the file downloading.
+    It is not mandatory to provide this to the silc_client_file_receive.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientFileError.html b/docs/toolkit/manual/silcclient-SilcClientFileError.html new file mode 100644 index 0000000..b4cd889 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientFileError.html @@ -0,0 +1,296 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcClientFileError

    + + +NAME + +
    
+    typedef enum { ... } SilcClientFileError;
+
+
    +DESCRIPTION + +
    
+    File transmission error types.  These types are returned by
+    some of the file transmission functions, and by the monitor
+    callback to indicate error.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CLIENT_FILE_OK,
+      SILC_CLIENT_FILE_ERROR,                    /* Generic error */
+      SILC_CLIENT_FILE_UNKNOWN_SESSION,          /* Unknown session ID */
+      SILC_CLIENT_FILE_ALREADY_STARTED,          /* Session already started */
+      SILC_CLIENT_FILE_NO_SUCH_FILE,             /* No such file */
+      SILC_CLIENT_FILE_PERMISSION_DENIED,        /* Permission denied */
+      SILC_CLIENT_FILE_KEY_AGREEMENT_FAILED,     /* Key exchange failed */
+      SILC_CLIENT_FILE_CONNECT_FAILED,           /* Error during connecting */
+      SILC_CLIENT_FILE_TIMEOUT,                  /* Connecting timedout */
+      SILC_CLIENT_FILE_NO_MEMORY,                /* System out of memory */
+    } SilcClientFileError;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientFileMonitor.html b/docs/toolkit/manual/silcclient-SilcClientFileMonitor.html new file mode 100644 index 0000000..a64e1d8 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientFileMonitor.html @@ -0,0 +1,297 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcClientFileMonitor

    + + +SYNOPSIS + +
    
+    typedef void (*SilcClientFileMonitor)(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcClientMonitorStatus status,
+                                          SilcClientFileError error,
+                                          SilcUInt64 offset,
+                                          SilcUInt64 filesize,
+                                          SilcClientEntry client_entry,
+                                          SilcUInt32 session_id,
+                                          const char *filepath,
+                                          void *context);
+
+
    +DESCRIPTION + +
    
+    Monitor callback that is called during the file transmission to
+    monitor the transmission process.  The `status' indicates the current
+    monitoring process.  The `error' will indicate the error type
+    if `status' is SILC_CLIENT_FILE_MONITOR_ERROR.  The `offset' is the
+    currently transmitted amount of total `filesize'.  The `client_entry'
+    indicates the remote client, and the transmission session ID is the
+    `session_id'.  The filename being transmitted is indicated by the
+    `filepath'.  The `conn' is NULL if the connection to remote client
+    does not exist yet.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientFileName.html b/docs/toolkit/manual/silcclient-SilcClientFileName.html new file mode 100644 index 0000000..c1f336a --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientFileName.html @@ -0,0 +1,283 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcClientFileName

    + + +SYNOPSIS + +
    
+    typedef void (*SilcClientFileName)(const char *filepath,
+                                       void *context);
+
+
    +DESCRIPTION + +
    
+    Completion callback for the SilcClientFileAskName callback function.
+    Application calls this to deliver the filepath and filename where
+    the downloaded file is to be saved.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientMessageType.html b/docs/toolkit/manual/silcclient-SilcClientMessageType.html new file mode 100644 index 0000000..b8dc7ef --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientMessageType.html @@ -0,0 +1,290 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcClientMessageType

    + + +NAME + +
    
+    typedef enum { ... } SilcClientMessageType;
+
+
    +DESCRIPTION + +
    
+    Different message types for `say' client operation.  The application
+    may filter the message sent by the library according this type.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CLIENT_MESSAGE_INFO,            /* Informational */
+      SILC_CLIENT_MESSAGE_WARNING,         /* Warning */
+      SILC_CLIENT_MESSAGE_ERROR,           /* Error */
+      SILC_CLIENT_MESSAGE_COMMAND_ERROR,   /* Error during command */
+      SILC_CLIENT_MESSAGE_AUDIT,           /* Auditable */
+    } SilcClientMessageType;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientMonitorStatus.html b/docs/toolkit/manual/silcclient-SilcClientMonitorStatus.html new file mode 100644 index 0000000..220abfb --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientMonitorStatus.html @@ -0,0 +1,316 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcClientMonitorStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcClientMonitorStatus;
+
+
    +DESCRIPTION + +
    
+    File transmission session status types.  These will indicate
+    the status of the file transmission session.
+
+    The SILC_CLIENT_FILE_MONITOR_KEY_AGREEMENT is called when session
+    is key exchange phase.
+
+    The SILC_CLIENT_FILE_MONITOR_SEND is called when data is being sent
+    to remote client.
+
+    The SILC_CLIENT_FILE_MONITOR_RECEIVE is called when data is being
+    recieved from remote client.
+
+    The SILC_CLIENT_FILE_MONITOR_CLOSED will be called when the user
+    issues silc_client_file_close.  If needed, it may be ignored in the
+    monitor callback.
+
+    The SILC_CLIENT_FILE_MONITOR_DISCONNECT will be called if remote
+    disconnects the session connection.  The silc_client_file_close must
+    be called when this status is received.  The session is over when
+    this is received.
+
+    The SILC_CLIENLT_FILE_MONITOR_ERROR is called in case some error
+    occured.  The SilcClientFileError will indicate more detailed error
+    condition.  The silc_client_file_close must be called when this status
+    is received.  The session is over when this is received.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CLIENT_FILE_MONITOR_KEY_AGREEMENT,    /* In key agreemenet phase */
+      SILC_CLIENT_FILE_MONITOR_SEND,             /* Sending file */
+      SILC_CLIENT_FILE_MONITOR_RECEIVE,          /* Receiving file */
+      SILC_CLIENT_FILE_MONITOR_GET,              /* Unsupported */
+      SILC_CLIENT_FILE_MONITOR_PUT,              /* Unsupported */
+      SILC_CLIENT_FILE_MONITOR_CLOSED,           /* Session closed */
+      SILC_CLIENT_FILE_MONITOR_DISCONNECT,       /* Session disconnected */
+      SILC_CLIENT_FILE_MONITOR_ERROR,            /* Error during session */
+    } SilcClientMonitorStatus;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientOperations.html b/docs/toolkit/manual/silcclient-SilcClientOperations.html new file mode 100644 index 0000000..ff2be0b --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientOperations.html @@ -0,0 +1,411 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClientOperations

    + + +NAME + +
    
+    typedef struct { ... } SilcClientOperations;
+
+
    +DESCRIPTION + +
    
+    SILC Client Operations. These must be implemented by the application.
+    The Client library may call any of these routines at any time.  The
+    routines are used to deliver certain information to the application
+    or from the application to the client library.
+
+
    +SOURCE + +
        typedef struct SilcClientOperationsStruct {
+      /* Message sent to the application by library. `conn' associates the
+         message to a specific connection.  `conn', however, may be NULL.
+         The `type' indicates the type of the message sent by the library.
+         The application can for example filter the message according the
+         type.  The variable argument list is arguments to the formatted
+         message `msg'.  A SilcClientEntry, SilcChannelEntry or SilcServerEntry
+         can be associated with the message inside the `conn' by the library,
+         and application may use it to better target the message. */
+      void (*say)(SilcClient client, SilcClientConnection conn,
+                  SilcClientMessageType type, char *msg, ...);
+    
+      /* Message for a channel. The `sender' is the sender of the message
+         The `channel' is the channel. The `message' is the message.  Note
+         that `message' maybe NULL.  The `flags' indicates message flags
+         and it is used to determine how the message can be interpreted
+         (like it may tell the message is multimedia message).  The `payload'
+         may be used to retrieve all the details of the message. */
+      void (*channel_message)(SilcClient client, SilcClientConnection conn,
+                              SilcClientEntry sender, SilcChannelEntry channel,
+                              SilcMessagePayload payload,
+                              SilcChannelPrivateKey key, SilcMessageFlags flags,
+                              const unsigned char *message,
+                              SilcUInt32 message_len);
+    
+      /* Private message to the client. The `sender' is the sender of the
+         message. The message is `message'and maybe NULL.  The `flags'
+         indicates message flags  and it is used to determine how the message
+         can be interpreted (like it may tell the message is multimedia
+         message).  The `payload' may be used to retrieve all the details of
+         the message. */
+      void (*private_message)(SilcClient client, SilcClientConnection conn,
+                              SilcClientEntry sender, SilcMessagePayload payload,
+                              SilcMessageFlags flags, const unsigned char *message,
+                              SilcUInt32 message_len);
+    
+      /* Notify message to the client.  The arguments are notify `type' specific.
+         See separate documentation in the Toolkit Reference Manual for the notify
+         arguments. */
+      void (*notify)(SilcClient client, SilcClientConnection conn,
+                     SilcNotifyType type, ...);
+    
+      /* Command handler. This function is called always after application has
+         called a command.  It will be called to indicate that the command
+         was processed.  It will also be called if error occurs while processing
+         the command.  The `success' indicates whether the command was sent
+         or if error occurred.  The `status' indicates the actual error.
+         The `argc' and `argv' are the command line arguments sent to the
+         command by application.  Note that, this is not reply to the command
+         from server, this is merely and indication to application that the
+         command was processed. */
+      void (*command)(SilcClient client, SilcClientConnection conn,
+                      SilcBool success, SilcCommand command, SilcStatus status,
+                      SilcUInt32 argc, unsigned char **argv);
+    
+      /* Command reply handler.  Delivers a reply to command that was sent
+         earlier.  The `conn' is the associated client connection.  The `command'
+         indicates the command reply type.  If the `status' other than
+         SILC_STATUS_OK an error occurred.  In this case the `error' will indicate
+         the error.  It is possible to receive list of command replies and list
+         of errors.  In this case the `status' will indicate it is an list entry
+         (the `status' is SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM and/or
+         SILC_STATUS_LIST_END).
+    
+         The arguments received in `ap' are command specific.  See a separate
+         documentation in the Toolkit Reference Manual for the command reply
+         arguments. */
+      void (*command_reply)(SilcClient client, SilcClientConnection conn,
+                            SilcCommand command, SilcStatus status,
+                            SilcStatus error, va_list ap);
+    
+      /* Find authentication method and authentication data by hostname and
+         port. The hostname may be IP address as well. The `auth_method' is
+         the authentication method the remote connection requires.  It is
+         however possible that remote accepts also some other authentication
+         method.  Application should use the method that may have been
+         configured for this connection.  If none has been configured it should
+         use the required `auth_method'.  If the `auth_method' is
+         SILC_AUTH_NONE, server does not require any authentication or the
+         required authentication method is not known.  The `completion'
+         callback must be called to deliver the chosen authentication method
+         and data. The `conn' may be NULL. */
+      void (*get_auth_method)(SilcClient client, SilcClientConnection conn,
+                              char *hostname, SilcUInt16 port,
+                              SilcAuthMethod auth_method,
+                              SilcGetAuthMeth completion, void *context);
+    
+      /* Called to verify received public key. The `conn_type' indicates which
+         entity (server or client) has sent the public key. If user decides to
+         trust the key the application may save the key as trusted public key for
+         later use. The `completion' must be called after the public key has
+         been verified. */
+      void (*verify_public_key)(SilcClient client, SilcClientConnection conn,
+                                SilcConnectionType conn_type,
+                                SilcPublicKey public_key,
+                                SilcVerifyPublicKey completion, void *context);
+    
+      /* Ask from end user a passphrase or a password. The passphrase is
+         returned to the library by calling the `completion' callback with
+         the `context'. The returned passphrase SHOULD be in UTF-8 encoded,
+         if not then the library will attempt to encode. */
+      void (*ask_passphrase)(SilcClient client, SilcClientConnection conn,
+                             SilcAskPassphrase completion, void *context);
+    
+      /* Called to indicate that incoming key agreement request has been
+         received.  If the application wants to perform key agreement it may
+         call silc_client_perform_key_agreement to initiate key agreement or
+         silc_client_send_key_agreement to provide connection point to the
+         remote client in case the `hostname' is NULL.  If key agreement is
+         not desired this request can be ignored.  The `protocol' is either
+         value 0 for TCP or value 1 for UDP. */
+      void (*key_agreement)(SilcClient client, SilcClientConnection conn,
+                            SilcClientEntry client_entry,
+                            const char *hostname, SilcUInt16 protocol,
+                            SilcUInt16 port);
+    
+      /* Notifies application that file transfer protocol session is being
+         requested by the remote client indicated by the `client_entry' from
+         the `hostname' and `port'. The `session_id' is the file transfer
+         session and it can be used to either accept or reject the file
+         transfer request, by calling the silc_client_file_receive or
+         silc_client_file_close, respectively. */
+      void (*ftp)(SilcClient client, SilcClientConnection conn,
+                  SilcClientEntry client_entry, SilcUInt32 session_id,
+                  const char *hostname, SilcUInt16 port);
+    } SilcClientOperations;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientParams.html b/docs/toolkit/manual/silcclient-SilcClientParams.html new file mode 100644 index 0000000..d6e3465 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientParams.html @@ -0,0 +1,355 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClientParams

    + + +NAME + +
    
+    typedef struct { ... } SilcClientParams;
+
+
    +DESCRIPTION + +
    
+    Client parameters. This can be filled with proper values and
+    given as argument to the silc_client_alloc function. The structure
+    hold various parameters which affects the function of the client.
+
+
    +SOURCE + +
        typedef struct SilcClientParamsStruct {
+      /* If this boolean is set to TRUE then the client library will use
+         threads.  Any of the callback functions in the SilcClientOperations
+         and other callbacks may be called at any time in a thread.  The
+         application may need to employ appropriate concurrency control
+         in the callbacks to protect application specific data. */
+      SilcBool threads;
+    
+      /* Nickname format string. This can be used to order the client library
+         to save the nicknames in the library in a certain format. Since
+         nicknames are not unique in SILC it is possible to have multiple same
+         nicknames. Using this format string it is possible to order the library
+         to separate the multiple same nicknames from each other. If this is
+         empty then default format is used which is the default nickname
+         without anything else. The string MUST be NULL terminated.
+    
+         Following format types are available:
+    
+         %n  nickname      - the real nickname returned by the server (mandatory)
+         %a  number        - ascending number in case there are several
+                             same nicknames (fe. nick#2 and nick#3)
+         %h  hostname      - the stripped hostname of the client
+         %H  full hostname - the full hostname of the client
+    
+         Example format strings: "%n#%a"     (fe. nick#2, nick#3)
+                                 "%n#%h%a"   (fe. nick#host, nick#host2)
+                                 "%a!%n#%h"  (fe. nick#host, 2!nick#host)
+    
+         Note that there must always be some separator characters around '%n'
+         format.  It is not possible to put format characters before or after
+         '%n' without separators (such ash '#').  Also note that the separator
+         character should be a character that cannot be part of normal nickname.
+         Note that, using '@' as a separator is not recommended as the nickname
+         string may contain it to separate a server name from the nickname (eg.
+         nickname@silcnet.org).
+      */
+      char nickname_format[32];
+    
+      /* If this is set to TRUE then the `nickname_format' is employed to all
+         saved nicknames even if there are no multiple same nicknames in the
+         cache. By default this is FALSE, which means that the `nickname_format'
+         is employed only if the library will receive a nickname that is
+         already saved in the cache. It is recommended to leave this to FALSE
+         value. */
+      SilcBool nickname_force_format;
+    
+      /* If this is set to TRUE then all nickname strings returned by the library
+         and stored by the library are in the format of 'nickname@server', eg.
+         nickname@silcnet.org.  If this is FALSE then the server name of the
+         nickname is available only from the SilcClientEntry structure.  When this
+         is TRUE the server name is still parsed to SilcClientEntry. */
+      SilcBool full_nicknames;
+    
+      /* If this is set to TRUE then all channel name strings returned by the
+         library and stored by the library are in the format of 'channel@server',
+         eg. silc@silcnet.org.  If this is FALSE then the server name of the
+         channel is available only from the SilcChannelEntry structure.  When this
+         is TRUE the server name is still parsed to SilcChannelEntry.  Note that,
+         not all SILC server versions return such channel name strings. */
+      SilcBool full_channel_names;
+    
+      /* If this is set to TRUE, the silcclient library will not register and
+         deregister the cipher, pkcs, hash and hmac algorithms. The application
+         itself will need to handle that. */
+      SilcBool dont_register_crypto_library;
+    
+      /* If this is set to TRUE, the silcclient library will not automatically
+         negotiate private message keys using SKE over the SILC network but will
+         use normal session keys to protect private messages. */
+      SilcBool dont_autoneg_prvmsg_keys;
+    } SilcClientParams;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientRunning.html b/docs/toolkit/manual/silcclient-SilcClientRunning.html new file mode 100644 index 0000000..bae26ca --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientRunning.html @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcClientRunning

    + + +SYNOPSIS + +
    
+    typedef void (*SilcClientRunning)(SilcClient client, void *context);
+
+
    +DESCRIPTION + +
    
+    The callback given as argument to silc_client_init function.  Once
+    this is called the client library is running and application may
+    start using the Client library API.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientStats.html b/docs/toolkit/manual/silcclient-SilcClientStats.html new file mode 100644 index 0000000..6fa8c08 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientStats.html @@ -0,0 +1,300 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClientStats

    + + +NAME + +
    
+    typedef struct { ... } SilcClientStats;
+
+
    +DESCRIPTION + +
    
+    This structure holds SILC network statistics returned by the
+    SILC_COMMAND_STATS command reply to the application.
+
+
    +SOURCE + +
        typedef struct SilcClientStatsStruct {
+      SilcUInt32 starttime;         /* SILC server start time */
+      SilcUInt32 uptime;            /* SILC server uptime*/
+      SilcUInt32 my_clients;        /* Number of clients in the server */
+      SilcUInt32 my_channels;       /* Number of channel in the server */
+      SilcUInt32 my_server_ops;     /* Number of server operators in the server */
+      SilcUInt32 my_router_ops;     /* Number of router operators in the router */
+      SilcUInt32 cell_clients;      /* Number of clients in the cell */
+      SilcUInt32 cell_channels;     /* Number of channels in the cell */
+      SilcUInt32 cell_servers;      /* Number of server in the cell */
+      SilcUInt32 clients;           /* All clients in SILC network */
+      SilcUInt32 channels;          /* All channels in SILC network */
+      SilcUInt32 servers;           /* All servers in SILC network */
+      SilcUInt32 routers;           /* All routers in SILC network */
+      SilcUInt32 server_ops;        /* All server operators in SILC network */
+      SilcUInt32 router_ops;        /* All router operators in SILC network */
+    } SilcClientStats;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcClientStopped.html b/docs/toolkit/manual/silcclient-SilcClientStopped.html new file mode 100644 index 0000000..116172f --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcClientStopped.html @@ -0,0 +1,285 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcClientStopped

    + + +SYNOPSIS + +
    
+    typedef void (*SilcClientStopped)(SilcClient client, void *context);
+
+
    +DESCRIPTION + +
    
+    The callback given as argument to silc_client_stop.  Once this is
+    called the client library has stopped and can be freed by calling
+    silc_client_free.  Note that this won't be called if there are
+    active connections in the client.  Connections must first be closed
+    by calling silc_client_close_connection or by sending QUIT command to
+    the server connection.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcGetAuthMeth.html b/docs/toolkit/manual/silcclient-SilcGetAuthMeth.html new file mode 100644 index 0000000..2f42065 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcGetAuthMeth.html @@ -0,0 +1,295 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcGetAuthMeth

    + + +SYNOPSIS + +
    
+    typedef void (*SilcGetAuthMeth)(SilcAuthMethod auth_meth,
+                                    const void *auth, SilcUInt32 auth_len,
+                                    void *context);
+
+
    +DESCRIPTION + +
    
+    Authentication data resolving callback. This is called by the
+    application to return the resolved authentication data. The client
+    library has called the get_auth_method client operation and given
+    this function pointer as argument. The `auth_meth' is the selected
+    authentication method. The `auth_data' and the `auth_data_len'
+    are the resolved authentication data. The `context' is the libary's
+    context sent to the get_auth_method client operation.
+
+    If the `auth_method' is SILC_AUTH_PASSWORD then `auth' and `auth_len'
+    is the passphrase and its length.  If it is SILC_AUTH_PUBLIC_KEY the
+    `auth' must be NULL.  The library will use the private key given as
+    argument to silc_client_connect_to_server, silc_client_connect_to_client
+    or silc_client_key_exchange.  If it is SILC_AUTH_NONE, both `auth' and
+    `auth_len' are ignored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcKeyAgreementCallback.html b/docs/toolkit/manual/silcclient-SilcKeyAgreementCallback.html new file mode 100644 index 0000000..080871c --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcKeyAgreementCallback.html @@ -0,0 +1,291 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcKeyAgreementCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcKeyAgreementCallback)(SilcClient client,
+                                             SilcClientConnection conn,
+                                             SilcClientEntry client_entry,
+                                             SilcKeyAgreementStatus status,
+                                             SilcSKEKeyMaterial *key,
+                                             void *context);
+
+
    +DESCRIPTION + +
    
+    Key agreement callback that is called after the key agreement protocol
+    has been performed. This is called also if error occurred during the
+    key agreement protocol. The `key' is the allocated key material and
+    the caller is responsible of freeing it. The `key' is NULL if error
+    has occurred. The application can freely use the `key' to whatever
+    purpose it needs. See lib/silcske/silcske.h for the definition of
+    the SilcSKEKeyMaterial structure.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcKeyAgreementStatus.html b/docs/toolkit/manual/silcclient-SilcKeyAgreementStatus.html new file mode 100644 index 0000000..511f005 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcKeyAgreementStatus.html @@ -0,0 +1,294 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcKeyAgreementStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcKeyAgreementStatus;
+
+
    +DESCRIPTION + +
    
+    Key agreement status types indicating the status of the key
+    agreement protocol.  These types are returned to the application
+    in the SilcKeyAgreementCallback callback function.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_KEY_AGREEMENT_OK,               /* Everything is Ok */
+      SILC_KEY_AGREEMENT_ERROR,            /* Unknown error occurred */
+      SILC_KEY_AGREEMENT_FAILURE,          /* The protocol failed */
+      SILC_KEY_AGREEMENT_TIMEOUT,          /* The protocol timeout */
+      SILC_KEY_AGREEMENT_ABORTED,          /* The protocol aborted */
+      SILC_KEY_AGREEMENT_ALREADY_STARTED,  /* Already started */
+      SILC_KEY_AGREEMENT_SELF_DENIED,      /* Negotiationg with itself denied */
+      SILC_KEY_AGREEMENT_NO_MEMORY,        /* System out of memory */
+    } SilcKeyAgreementStatus;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcPrivateMessageKeys.html b/docs/toolkit/manual/silcclient-SilcPrivateMessageKeys.html new file mode 100644 index 0000000..91411f5 --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcPrivateMessageKeys.html @@ -0,0 +1,292 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPrivateMessageKeys

    + + +NAME + +
    
+    typedef struct { ... } SilcPrivateMessageKeys;
+
+
    +DESCRIPTION + +
    
+    Structure to hold the list of private message keys. The list of these
+    structures is returned by the silc_client_list_private_message_keys
+    function.
+
+
    +SOURCE + +
        typedef struct SilcPrivateMessageKeysStruct {
+      SilcClientEntry client_entry;       /* The remote client entry */
+      char *cipher;                       /* The cipher name */
+      unsigned char *key;                 /* The original key, If the appliation
+                                             provided it. This is NULL if
+                                             the SKE key material was used. */
+      SilcUInt32 key_len;                 /* The key length */
+    } *SilcPrivateMessageKeys;
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-SilcVerifyPublicKey.html b/docs/toolkit/manual/silcclient-SilcVerifyPublicKey.html new file mode 100644 index 0000000..51f895e --- /dev/null +++ b/docs/toolkit/manual/silcclient-SilcVerifyPublicKey.html @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcVerifyPublicKey

    + + +SYNOPSIS + +
    
+    typedef void (*SilcVerifyPublicKey)(SilcBool success, void *context);
+
+
    +DESCRIPTION + +
    
+    Public key (or certificate) verification callback. This is called
+    by the application to indicate that the public key verification was
+    either success or failure.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_abort_key_agreement.html b/docs/toolkit/manual/silcclient-silc_client_abort_key_agreement.html new file mode 100644 index 0000000..f46b008 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_abort_key_agreement.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_abort_key_agreement

    + + +SYNOPSIS + +
    
+    void silc_client_abort_key_agreement(SilcClient client,
+                                         SilcClientConnection conn,
+                                         SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    This function can be called to unbind the hostname and the port for
+    the key agreement protocol. However, this function has effect only
+    before the key agreement protocol has been performed. After it has
+    been performed the library will automatically unbind the port. The
+    `client_entry' is the client to which we sent the key agreement
+    request.  The key agreement completion callback will be called
+    with SILC_KEY_AGREEMENT_ABORTED status.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_add_channel_private_key.html b/docs/toolkit/manual/silcclient-silc_client_add_channel_private_key.html new file mode 100644 index 0000000..65da6c8 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_add_channel_private_key.html @@ -0,0 +1,321 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_add_channel_private_key

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_client_add_channel_private_key(SilcClient client,
+                                        SilcClientConnection conn,
+                                        SilcChannelEntry channel,
+                                        const char *name,
+                                        char *cipher,
+                                        char *hmac,
+                                        unsigned char *key,
+                                        SilcUInt32 key_len,
+                                        SilcChannelPrivateKey *ret_key);
+
+
    +DESCRIPTION + +
    
+    Adds private key for channel. When channel has private key then the
+    messages are encrypted using that key. All clients on the channel
+    must also know the key in order to decrypt the messages. However,
+    it is possible to have several private keys per one channel. In this
+    case only some of the clients on the channel may know the one key
+    and only some the other key.  The `name' can be application given
+    name for the key.  This returns the created key to the 'ret_key'
+    pointer if it is non-NULL;
+
+    If `cipher' and/or `hmac' is NULL then default values will be used
+    (aes-256-cbc for cipher and hmac-sha1-96 for hmac).
+
+    The private key for channel is optional. If it is not set then the
+    channel messages are encrypted using the channel key generated by the
+    server. However, setting the private key (or keys) for the channel
+    significantly adds security. If more than one key is set the library
+    will automatically try all keys at the message decryption phase. Note:
+    setting many keys slows down the decryption phase as all keys has to
+    be tried in order to find the correct decryption key. However, setting
+    a few keys does not have big impact to the decryption performace.
+
+
    +NOTES + +
    
+    NOTE: This is entirely local setting. The key set using this function
+    is not sent to the network at any phase.
+
+    NOTE: If the key material was originated by the SKE protocol (using
+    silc_client_send_key_agreement) then the `key' MUST be the
+    key->send_enc_key as this is dictated by the SILC protocol. However,
+    currently it is not expected that the SKE key material would be used
+    as channel private key. However, this API allows it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_add_private_message_key.html b/docs/toolkit/manual/silcclient-silc_client_add_private_message_key.html new file mode 100644 index 0000000..0889afb --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_add_private_message_key.html @@ -0,0 +1,305 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_add_private_message_key

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_client_add_private_message_key(SilcClient client,
+                                        SilcClientConnection conn,
+                                        SilcClientEntry client_entry,
+                                        const char *cipher,
+                                        const char *hmac,
+                                        unsigned char *key,
+                                        SilcUInt32 key_len);
+
+
    +DESCRIPTION + +
    
+    Adds a static private message key to the client library.  The key
+    will be used to encrypt all private message between the client and
+    the remote client indicated by the `client_entry'.  The `key' can
+    be for example a pre-shared-key, passphrase or similar shared secret
+    string.  The `cipher' and `hmac' MAY be provided but SHOULD be NULL
+    to assure that the requirements of the SILC protocol are met. The
+    API, however, allows to allocate any cipher and HMAC.
+
+    If the private message key is added to client without first receiving
+    a request for it from the remote `client_entry' this function will
+    send the request to `client_entry'.  Note that, the actual key is
+    not sent to the network.
+
+    It is not necessary to set key for normal private message usage. If the
+    key is not set then the private messages are encrypted using normal
+    session keys.  Setting the private key, however, increases security.
+
+    Returns FALSE if the key is already set for the `client_entry', TRUE
+    otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_add_private_message_key_ske.html b/docs/toolkit/manual/silcclient-silc_client_add_private_message_key_ske.html new file mode 100644 index 0000000..baac19c --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_add_private_message_key_ske.html @@ -0,0 +1,290 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_add_private_message_key_ske

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_client_add_private_message_key_ske(SilcClient client,
+                                            SilcClientConnection conn,
+                                            SilcClientEntry client_entry,
+                                            const char *cipher,
+                                            const char *hmac,
+                                            SilcSKEKeyMaterial key);
+
+
    +DESCRIPTION + +
    
+    Same as silc_client_add_private_message_key but takes the key material
+    from the SKE key material structure.  This structure is received if
+    the application uses the silc_client_send_key_agreement to negotiate
+    the key material.  The `cipher' and `hmac' SHOULD be provided as it is
+    negotiated also in the SKE protocol.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_alloc.html b/docs/toolkit/manual/silcclient-silc_client_alloc.html new file mode 100644 index 0000000..723a05a --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_alloc.html @@ -0,0 +1,289 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_alloc

    + + +SYNOPSIS + +
    
+    SilcClient silc_client_alloc(SilcClientOperations *ops,
+                                 SilcClientParams *params,
+                                 void *application,
+                                 const char *silc_version);
+
+
    +DESCRIPTION + +
    
+    Allocates new client object. This has to be done before client may
+    work. After calling this one must call silc_client_init to initialize
+    the client. The `application' is application specific user data pointer
+    and caller must free it. The `silc_version' is the application version
+    that will be used to compare against remote host's (usually a server)
+    version string.  The `application' context is accessible by the
+    application by client->application, client being SilcClient.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_attribute_add.html b/docs/toolkit/manual/silcclient-silc_client_attribute_add.html new file mode 100644 index 0000000..da6c2af --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_attribute_add.html @@ -0,0 +1,300 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_attribute_add

    + + +SYNOPSIS + +
    
+    SilcAttributePayload
+    silc_client_attribute_add(SilcClient client,
+                              SilcClientConnection conn,
+                              SilcAttribute attribute,
+                              void *object,
+                              SilcUInt32 object_size);
+
+
    +DESCRIPTION + +
    
+    Add new Requsted Attribute for WHOIS command to the client library.
+    The `attribute' object indicated by `object' is added and allocated
+    SilcAttributePayload is returned.  The `object' must be of correct
+    type and of correct size.  See the SilcAttribute for object types
+    for different attributes.  You may also get all added attributes
+    from the client with silc_client_attributes_get function.
+
+    Requested Attributes are different personal information about the
+    user, status information and other information which other users
+    may query with WHOIS command.  Application may set these so that
+    if someone sends WHOIS query these attributes will be replied back
+    to the sender.  The library always puts the public key to the
+    Requested Attributes, but if application wishes to add additional
+    public keys (or certificates) it can be done with this interface.
+    Library also always computes digital signature of the attributes
+    automatically, so application does not need to do that.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_attribute_del.html b/docs/toolkit/manual/silcclient-silc_client_attribute_del.html new file mode 100644 index 0000000..c52f9cf --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_attribute_del.html @@ -0,0 +1,290 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_attribute_del

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_attribute_del(SilcClient client,
+                                   SilcClientConnection conn,
+                                   SilcAttribute attribute,
+                                   SilcAttributePayload attr);
+
+
    +DESCRIPTION + +
    
+    Delete a Requested Attribute from the client.  If the `attribute'
+    is non-zero then all attributes of that type are deleted and the
+    `attr' is ignored.  If `attr' is non-NULL then that specific
+    attribute is deleted and `attribute' is ignored.
+
+    You may get all added attributes with the function
+    silc_client_attributes_get and to get the SilcAttributePayload.
+    This function Returns TRUE if the attribute was found and deleted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_attributes_get.html b/docs/toolkit/manual/silcclient-silc_client_attributes_get.html new file mode 100644 index 0000000..7953578 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_attributes_get.html @@ -0,0 +1,287 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_attributes_get

    + + +SYNOPSIS + +
    
+    const SilcHashTable
+    silc_client_attributes_get(SilcClient client,
+                               SilcClientConnection conn);
+
+
    +DESCRIPTION + +
    
+    Returns pointer to the SilcHashTable which includes all the added
+    Requested Attributes.  The caller must not free the hash table.
+    The caller may use SilcHashTableList and silc_hash_table_list to
+    traverse the table.  Each entry in the hash table is one added
+    SilcAttributePayload.  It is possible to delete a attribute
+    payload while traversing the table.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_attributes_request.html b/docs/toolkit/manual/silcclient-silc_client_attributes_request.html new file mode 100644 index 0000000..32fda07 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_attributes_request.html @@ -0,0 +1,298 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_attributes_request

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_client_attributes_request(SilcAttribute attribute, ...);
+
+
    +DESCRIPTION + +
    
+    Constructs a Requested Attributes buffer. If the `attribute' is zero (0)
+    then all attributes are requested.  Alternatively, `attribute' and
+    all variable arguments can each be requested attribute.  In this case
+    the last must be set to zero (0) to complete the variable list of
+    requested attributes.  See SilcAttribute for all attributes.
+    You can give the returned buffer as argument to for example
+    silc_client_get_client_by_id_resolve function.
+
+
    +EXAMPLE + +
    
+    Request all attributes
+    buffer = silc_client_attributes_request(0);
+
+    Request only the following attributes
+    buffer = silc_client_attributes_request(SILC_ATTRIBUTE_USER_INFO,
+                                            SILC_ATTRIBUTE_SERVICE,
+                                            SILC_ATTRIBUTE_MOOD, 0);
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_close_connection.html b/docs/toolkit/manual/silcclient-silc_client_close_connection.html new file mode 100644 index 0000000..bff9205 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_close_connection.html @@ -0,0 +1,286 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_close_connection

    + + +SYNOPSIS + +
    
+    void silc_client_close_connection(SilcClient client,
+                                      SilcClientConnection conn);
+
+
    +DESCRIPTION + +
    
+    Closes the remote connection `conn'.  The `conn' will become invalid
+    after this call.  Usually this function is called only when explicitly
+    closing connection for example in case of error, or when the remote
+    connection was created by the application or when the remote is client
+    connection.  Server connections are usually closed by sending QUIT
+    command to the server.  However, this call may also be used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_command_call.html b/docs/toolkit/manual/silcclient-silc_client_command_call.html new file mode 100644 index 0000000..3b12149 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_command_call.html @@ -0,0 +1,322 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_command_call

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_client_command_call(SilcClient client,
+                                        SilcClientConnection conn,
+                                        const char *command_line, ...);
+
+
    +DESCRIPTION + +
    
+    Calls and executes the command indicated by the `command_name'.
+    The `command_line' is a string which includes the command's name and
+    its arguments separated with whitespaces (' ').  If `command_line'
+    is non-NULL then all variable arguments are ignored by default.
+
+    If `command_line' is NULL, then the variable arguments define the
+    command's name and its arguments.  The first variable argument must
+    be the command name.  The variable argument list must be terminated
+    with NULL.
+
+    Returns command identifier for this sent command.  It can be used
+    to additionally attach to the command reply using the function
+    silc_client_command_pending, if needed.  Returns 0 on error.
+
+    The `command' client operation callback will be called when the
+    command is executed to indicate whether or not the command executed
+    successfully.
+
+    The `command_reply' client operation callbak will be called when reply
+    is received from the server to the command.  Application may also use
+    the silc_client_command_pending to attach to the command reply.
+    The command identifier for silc_client_command_pending function after
+    this function call is conn->cmd_ident, which application may use.
+
+
    +EXAMPLE + +
    
+    silc_client_command_call(client, conn, NULL, "PING", "silc.silcnet.org",
+                             NULL);
+    silc_client_command_call(client, conn, "PING silc.silcnet.org");
+
+
    +NOTES + +
    
+    This command executes the commands implemented inside the client
+    library.  These commands are designed for command line applications,
+    but GUI application may call them too if needed.  Alternatively
+    application may override the library and use silc_client_command_send
+    function instead.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_command_pending.html b/docs/toolkit/manual/silcclient-silc_client_command_pending.html new file mode 100644 index 0000000..542f92b --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_command_pending.html @@ -0,0 +1,314 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_command_pending

    + + +SYNOPSIS + +
    
+    void silc_client_command_pending(SilcClientConnection conn,
+                                     SilcCommand command,
+                                     SilcUInt16 cmd_ident,
+                                     SilcClientCommandReply reply,
+                                     void *context);
+
+
    +DESCRIPTION + +
    
+    This function can be used to add pending command callback to be
+    called when an command reply is received to an earlier sent command.
+    The `command' is the command that must be received in order for
+    the pending command callback indicated by `callback' to be called.
+
+    The `cmd_ident' is a command identifier which was set for the earlier
+    sent command.  The command reply will include the same identifier
+    and pending command callback will be called when the reply is
+    received with the same command identifier.  It is possible to
+    add multiple pending command callbacks for same command and for
+    same identifier.
+
+    Application may use this function to add its own command reply
+    handlers if it wishes not to use the standard `command_reply'
+    client operation.
+
+    Note also that the application is notified about the received command
+    reply through the `command_reply' client operation before calling
+    the `callback` pending command callback.  That is the normal
+    command reply handling, and is called regardless whether pending
+    command callbacks are used or not.
+
+
    +EXAMPLE + +
    
+    SilcUInt16 cmd_ident;
+    cmd_ident = silc_client_command_call(client, conn,
+                                         "PING silc.silcnet.org");
+    silc_client_command_pending(conn, SILC_COMMAND_PING, cmd_ident,
+                                my_ping_handler, my_ping_context);
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_command_send.html b/docs/toolkit/manual/silcclient-silc_client_command_send.html new file mode 100644 index 0000000..f283ab6 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_command_send.html @@ -0,0 +1,312 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_command_send

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_client_command_send(SilcClient client,
+                                        SilcClientConnection conn,
+                                        SilcCommand command,
+                                        SilcClientCommandReply reply,
+                                        void *reply_context,
+                                        SilcUInt32 argc, ...);
+
+
    +DESCRIPTION + +
    
+    Generic function to send any command.  The arguments must be given
+    already encoded into correct format and in correct order. If application
+    wants to perform the commands by itself, it can do so and send the data
+    directly to the server using this function.  If application is using
+    the silc_client_command_call, this function is usually not used.
+    Programmer should get familiar with the SILC protocol commands
+    specification when using this function, as the arguments needs to
+    be encoded as specified in the protocol.
+
+    The variable arguments are a set of { type, data, data_length },
+    and the `argc' is the number of these sets.
+
+    The `reply' callback must be provided, and it is called when the
+    command reply is received from the server.  Note that, when using this
+    function the default `command_reply' client operation callback will not
+    be called when reply is received.
+
+    Returns command identifier for this sent command.  It can be used
+    to additionally attach to the command reply using the function
+    silc_client_command_pending, if needed.  Returns 0 on error.
+
+
    +EXAMPLE + +
    
+    silc_client_command_send(client, conn, SILC_COMMAND_WHOIS,
+                             my_whois_command_reply, cmd_ctx,
+                             1, 1, nickname, strlen(nickname));
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_connect_to_client.html b/docs/toolkit/manual/silcclient-silc_client_connect_to_client.html new file mode 100644 index 0000000..e2ca82a --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_connect_to_client.html @@ -0,0 +1,302 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_connect_to_client

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_client_connect_to_client(SilcClient client,
+                                  SilcClientConnectionParams *params,
+                                  SilcPublicKey public_key,
+                                  SilcPrivateKey private_key,
+                                  char *remote_host, int port,
+                                  SilcClientConnectCallback callback,
+                                  void *context);
+
+
    +DESCRIPTION + +
    
+    Connects to remote client `remote_host' at port `port'.  This function
+    can be used to create peer-to-peer connection to another SILC client,
+    for example, for direct conferencing, or file transfer or for other
+    purposes.  The `params' may be provided to provide various connection
+    parameters.  The `public_key' and the `private_key' is your identity
+    used in this connection.  The `callback' with `context' will be called
+    after the connection has been created.  It will also be called later
+    when remote host disconnects.
+
+    If application wishes to create the network connection itself, use
+    the silc_client_key_exchange after creating the connection to start
+    key exchange with the client.
+
+    Returns SilcAsyncOperation which can be used to cancel the connecting,
+    or NULL on error.  Note that the returned pointer becomes invalid
+    after the `callback' is called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_connect_to_server.html b/docs/toolkit/manual/silcclient-silc_client_connect_to_server.html new file mode 100644 index 0000000..746ddbf --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_connect_to_server.html @@ -0,0 +1,303 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_connect_to_server

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_client_connect_to_server(SilcClient client,
+                                  SilcClientConnectionParams *params,
+                                  SilcPublicKey public_key,
+                                  SilcPrivateKey private_key,
+                                  char *remote_host, int port,
+                                  SilcClientConnectCallback callback,
+                                  void *context);
+
+
    +DESCRIPTION + +
    
+    Connects to remote server `remote_host' at port `port'.  This function
+    can be used to create connection to remote SILC server and start
+    SILC session in the SILC network.  The `params' may be provided
+    to provide various connection parameters.  The `public_key' and the
+    `private_key' is your identity used in this connection.  When
+    authentication method is based on digital signatures, this key pair
+    will be used.  The `callback' with `context' will be called after the
+    connection has been created.  It will also be called later when remote
+    host disconnects.
+
+    If application wishes to create the network connection itself, use
+    the silc_client_key_exchange after creating the connection to start
+    key exchange and authentication with the server.
+
+    Returns SilcAsyncOperation which can be used to cancel the connecting,
+    or NULL on error.  Note that the returned pointer becomes invalid
+    after the `callback' is called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_current_channel_private_key.html b/docs/toolkit/manual/silcclient-silc_client_current_channel_private_key.html new file mode 100644 index 0000000..d0686fc --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_current_channel_private_key.html @@ -0,0 +1,285 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_current_channel_private_key

    + + +SYNOPSIS + +
    
+    void silc_client_current_channel_private_key(SilcClient client,
+                                                 SilcClientConnection conn,
+                                                 SilcChannelEntry channel,
+                                                 SilcChannelPrivateKey key);
+
+
    +DESCRIPTION + +
    
+    Sets the `key' to be used as current channel private key on the
+    `channel'.  Packet sent after calling this function will be secured
+    with `key'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_del_channel_private_key.html b/docs/toolkit/manual/silcclient-silc_client_del_channel_private_key.html new file mode 100644 index 0000000..a9214d7 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_del_channel_private_key.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_del_channel_private_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_del_channel_private_key(SilcClient client,
+                                                 SilcClientConnection conn,
+                                                 SilcChannelEntry channel,
+                                                 SilcChannelPrivateKey key);
+
+
    +DESCRIPTION + +
    
+    Removes and frees private key `key' from the channel `channel'.
+    The `key' is retrieved by calling the function
+    silc_client_list_channel_private_keys. The key is not used after
+    this. If the key was last private key then the old channel key is
+    used hereafter to protect the channel messages. This returns FALSE
+    on error, TRUE otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_del_channel_private_keys.html b/docs/toolkit/manual/silcclient-silc_client_del_channel_private_keys.html new file mode 100644 index 0000000..3791cd7 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_del_channel_private_keys.html @@ -0,0 +1,284 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_del_channel_private_keys

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_del_channel_private_keys(SilcClient client,
+                                                  SilcClientConnection conn,
+                                                  SilcChannelEntry channel);
+
+
    +DESCRIPTION + +
    
+    Removes all private keys from the `channel'. The old channel key is used
+    after calling this to protect the channel messages. Returns FALSE on
+    on error, TRUE otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_del_private_message_key.html b/docs/toolkit/manual/silcclient-silc_client_del_private_message_key.html new file mode 100644 index 0000000..d6fcc9f --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_del_private_message_key.html @@ -0,0 +1,285 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_del_private_message_key

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_client_del_private_message_key(SilcClient client,
+                                        SilcClientConnection conn,
+                                        SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Removes the private message from the library. The key won't be used
+    after this to protect the private messages with the remote `client_entry'
+    client. Returns FALSE on error, TRUE otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_file_close.html b/docs/toolkit/manual/silcclient-silc_client_file_close.html new file mode 100644 index 0000000..00ff82f --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_file_close.html @@ -0,0 +1,289 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_file_close

    + + +SYNOPSIS + +
    
+    SilcClientFileError silc_client_file_close(SilcClient client,
+                                               SilcClientConnection conn,
+                                               SilcUInt32 session_id);
+
+
    +DESCRIPTION + +
    
+    Closes file transmission session indicated by the `session_id'.
+    If file transmission is being conducted it will be aborted
+    automatically. This function is also used to close the session
+    after successful file transmission. This function can be used
+    also to reject incoming file transmission request.  If the
+    session was already started and the monitor callback was set
+    the monitor callback will be called with the monitor status
+    SILC_CLIENT_FILE_MONITOR_CLOSED.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_file_receive.html b/docs/toolkit/manual/silcclient-silc_client_file_receive.html new file mode 100644 index 0000000..c308b07 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_file_receive.html @@ -0,0 +1,313 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_file_receive

    + + +SYNOPSIS + +
    
+    SilcClientFileError
+    silc_client_file_receive(SilcClient client,
+                             SilcClientConnection conn,
+                             SilcClientConnectionParams *params,
+                             SilcPublicKey public_key,
+                             SilcPrivateKey private_key,
+                             SilcClientFileMonitor monitor,
+                             void *monitor_context,
+                             const char *path,
+                             SilcUInt32 session_id,
+                             SilcClientFileAskName ask_name,
+                             void *ask_name_context);
+
+
    +DESCRIPTION + +
    
+    Receives a file from a client indicated by the `client_entry'.  The
+    `session_id' indicates the file transmission session and it has been
+    received in the `ftp' client operation callback.  This will actually
+    perform the key agreement protocol with the remote client before
+    actually starting the file transmission.  The `monitor' callback
+    will be called to monitor the transmission.  If `path' is non-NULL
+    the file will be saved into that directory.  If NULL the file is
+    saved in the current working directory, unless the 'ask_name'
+    callback is non-NULL.  In this case the callback is called to ask
+    the path and filename from application.
+
+    The `params' is the connection related parameters.  If the remote client
+    provided connection point the `params' will be used when creating
+    connection to the remote client.  If remote client did not provide
+    connection point the `params' is used to provide connection point
+    locally for the remote client.  See silc_client_file_send for more
+    information on providing connection point for remote client.
+
+    The `public_key' and `private_key' is our identity in the key agreement.
+
+    If error will occur during the file transfer process the error status
+    will be returned in the monitor callback.  In this case the application
+    must call silc_client_file_close to close the session.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_file_send.html b/docs/toolkit/manual/silcclient-silc_client_file_send.html new file mode 100644 index 0000000..0820691 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_file_send.html @@ -0,0 +1,315 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_file_send

    + + +SYNOPSIS + +
    
+    SilcClientFileError
+    silc_client_file_send(SilcClient client,
+                          SilcClientConnection conn,
+                          SilcClientEntry client_entry,
+                          SilcClientConnectionParams *params,
+                          SilcPublicKey public_key,
+                          SilcPrivateKey private_key,
+                          SilcClientFileMonitor monitor,
+                          void *monitor_context,
+                          const char *filepath,
+                          SilcUInt32 *session_id);
+
+
    +DESCRIPTION + +
    
+    Sends a file indicated by the `filepath' to the remote client
+    indicated by the `client_entry'.  This will negotiate a secret key
+    with the remote client before actually starting the transmission of
+    the file.  The `monitor' callback will be called to monitor the
+    transmission of the file.
+
+    This returns a file session ID for the file transmission to the
+    `session_id' pointer.  It can be used to close the session (and
+    abort the file transmission) by calling the silc_client_file_close
+    function.  The session ID is also returned in the `monitor' callback.
+
+    If `params' is non-NULL and it has the `local_ip' and `local_port' set
+    the caller will provide the connection endpoint for the key agreement
+    connection.  The `bind_ip' can be used to bind to that IP instead of
+    `local_ip'.  Caller may also set the `repository', `verify_notfound'
+    and `timeout_secs' fields in `params'.  Other fields are ignored.
+    If `params' is NULL, then the `client_entry' is expected to provide
+    the connection endpoint for us.  It is recommended the `timeout_secs'
+    is specified in case the remote client does not reply anything to
+    the request.
+
+    The `public_key' and `private_key' is our identity in the key agreement.
+
+    If error will occur during the file transfer process the error status
+    will be returned in the monitor callback.  In this case the application
+    must call silc_client_file_close to close the session.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_free.html b/docs/toolkit/manual/silcclient-silc_client_free.html new file mode 100644 index 0000000..722215f --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_free.html @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_free

    + + +SYNOPSIS + +
    
+    void silc_client_free(SilcClient client);
+
+
    +DESCRIPTION + +
    
+    Frees client object and its internals.  The execution of the client
+    should be stopped with silc_client_stop function before calling
+    this function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_free_private_message_keys.html b/docs/toolkit/manual/silcclient-silc_client_free_private_message_keys.html new file mode 100644 index 0000000..9ebc1ea --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_free_private_message_keys.html @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_free_private_message_keys

    + + +SYNOPSIS + +
    
+    void silc_client_free_private_message_keys(SilcPrivateMessageKeys keys,
+                                               SilcUInt32 key_count);
+
+
    +DESCRIPTION + +
    
+    Frees the SilcPrivateMessageKeys array returned by the function
+    silc_client_list_private_message_keys.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_init.html b/docs/toolkit/manual/silcclient-silc_client_init.html new file mode 100644 index 0000000..7c76ec2 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_init.html @@ -0,0 +1,294 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_init

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_init(SilcClient client, const char *username,
+                              const char *hostname, const char *realname,
+                              SilcClientRunning running, void *context);
+
+
    +DESCRIPTION + +
    
+    Initializes the client. This makes all the necessary steps to make
+    the client ready to be run. One must call silc_client_run to run the
+    client. Returns FALSE if error occurred, TRUE otherwise.
+
+    The `username' and `hostname' strings must be given and they must be
+    UTF-8 encoded.  The `username' is the client's username in the
+    operating system, `hostname' is the client's host name and the
+    `realname' is the user's real name.
+
+    The `running' callback with `context' is called after the client is
+    running after silc_client_run or silc_client_run_one has been called.
+    Application may start using the Client library API after that.  Setting
+    the callback is optional, but highly recommended.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_key_exchange.html b/docs/toolkit/manual/silcclient-silc_client_key_exchange.html new file mode 100644 index 0000000..85b5c3f --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_key_exchange.html @@ -0,0 +1,337 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_key_exchange

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_client_key_exchange(SilcClient client,
+                             SilcClientConnectionParams *params,
+                             SilcPublicKey public_key,
+                             SilcPrivateKey private_key,
+                             SilcStream stream,
+                             SilcConnectionType conn_type,
+                             SilcClientConnectCallback callback,
+                             void *context);
+
+
    +DESCRIPTION + +
    
+    Starts key exchange protocol and authentication protocol in the
+    connection indicated by `stream'.  This function can be be used to
+    start SILC session with remote host (usually server) when the caller
+    has itself created the connection, instead of calling the function
+    silc_client_connect_to_server or silc_client_connect_to_client.  If
+    one of those functions was used this function must not be called as
+    in that case the key exchange is performed automatically.
+
+    Use this function only if you have created the connection by yourself.
+    After creating the connection the socket must be wrapped into a
+    socket stream.  See silcsocketstream.h for more information.  Note that
+    the `stream' must have valid remote IP address (and optionally also
+    hostname) and port set.
+
+    The `params' may be provided to provide various connection parameters.
+    The `public_key' and the `private_key' is your identity used in this
+    session.  The `callback' with `context' will be called after the session
+    has been set up.  It will also be called later when remote host
+    disconnects.  The `conn_type' is the type of session this is going to
+    be.  If the remote is SILC server it is SILC_CONN_SERVER or if it is
+    SILC client it is SILC_CONN_CLIENT.
+
+    Returns SilcAsyncOperation which can be used to cancel the connecting,
+    or NULL on error.  Note that the returned pointer becomes invalid
+    after the `callback' is called.
+
+
    +EXAMPLE + +
    
+    int sock;
+
+    // Create remote connection stream.  Resolve hostname and IP also.
+    sock = create_connection(remote_host, port);
+    silc_socket_tcp_stream_create(sock, TRUE, FALSE, schedule,
+                                  stream_create_cb, app);
+
+    // Stream callback delivers our new SilcStream context
+    void stream_create_cb(SilcSocketStreamStatus status, SilcStream stream,
+                          void *context)
+    {
+      ...
+      if (status != SILC_SOCKET_OK)
+        error(status);
+
+      // Start key exchange
+      silc_client_key_exchange(client, NULL, public_key, private_key,
+                               stream, SILC_CONN_SERVER, connection_cb, app);
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_list_channel_private_keys.html b/docs/toolkit/manual/silcclient-silc_client_list_channel_private_keys.html new file mode 100644 index 0000000..e9d9791 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_list_channel_private_keys.html @@ -0,0 +1,287 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_list_channel_private_keys

    + + +SYNOPSIS + +
    
+    SilcDList
+    silc_client_list_channel_private_keys(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcChannelEntry channel);
+
+
    +DESCRIPTION + +
    
+    Returns list of private keys associated to the `channel'.  The caller
+    must free the returned list with silc_dlist_uninit.  The pointers in
+    the list may be used to delete the specific key by giving the pointer
+    as argument to the function silc_client_del_channel_private_key.  Each
+    entry in the list is SilcChannelPrivateKey.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_list_private_message_keys.html b/docs/toolkit/manual/silcclient-silc_client_list_private_message_keys.html new file mode 100644 index 0000000..f475998 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_list_private_message_keys.html @@ -0,0 +1,289 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_list_private_message_keys

    + + +SYNOPSIS + +
    
+    SilcPrivateMessageKeys
+    silc_client_list_private_message_keys(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcUInt32 *key_count);
+
+
    +DESCRIPTION + +
    
+    Returns array of set private message keys associated to the connection
+    `conn'. Returns allocated SilcPrivateMessageKeys array and the array
+    count to the `key_count' argument. The array must be freed by the caller
+    by calling the silc_client_free_private_message_keys function. Note:
+    the keys returned in the array is in raw format. It might not be desired
+    to show the keys as is. The application might choose not to show the keys
+    at all or to show the fingerprints of the keys.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_nickname_format.html b/docs/toolkit/manual/silcclient-silc_client_nickname_format.html new file mode 100644 index 0000000..a24257b --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_nickname_format.html @@ -0,0 +1,299 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_nickname_format

    + + +SYNOPSIS + +
    
+    SilcClientEntry
+    silc_client_nickname_format(SilcClient client,
+                                SilcClientConnection conn,
+                                SilcClientEntry client_entry,
+                                SilcBool priority);
+
+
    +DESCRIPTION + +
    
+    Formats the nickname of `client_entry' according to the nickname
+    formatting rules set in SilcClientParams.  If the `priority' is TRUE
+    then the `client_entry' will always get the unformatted nickname.
+    If FALSE and there are more than one same nicknames in the client
+    the nickname will be formatted.
+
+    This returns NULL on error.  Otherwise, the client entry that was
+    formatted is returned.  If `priority' is FALSE this always returns
+    the `client_entry'.  If it is TRUE, this may return the client entry
+    that was formatted after giving the `client_entry' the unformatted
+    nickname.
+
+    Usually application does not need to call this function, as the library
+    automatically formats nicknames.  However, if application wants to
+    for example force the `client_entry' to always have the unformatted
+    nickname it may call this function to do so.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_nickname_parse.html b/docs/toolkit/manual/silcclient-silc_client_nickname_parse.html new file mode 100644 index 0000000..2c7816a --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_nickname_parse.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_nickname_parse

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_nickname_parse(SilcClient client,
+                                        SilcClientConnection conn,
+                                        char *nickname,
+                                        char **ret_nick);
+
+
    +DESCRIPTION + +
    
+    Parses the `nickname' according to the format string given in the
+    SilcClientParams.  Returns the parsed nickname into the `ret_nick'.
+    The caller must free the returned pointer.  Returns FALSE if error
+    occurred during parsing.  Returns TRUE if the nickname was parsed,
+    it was not formatted or if the format string has not been specified
+    in SilcClientParams.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_on_channel.html b/docs/toolkit/manual/silcclient-silc_client_on_channel.html new file mode 100644 index 0000000..d5a035e --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_on_channel.html @@ -0,0 +1,283 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_on_channel

    + + +SYNOPSIS + +
    
+    SilcChannelUser silc_client_on_channel(SilcChannelEntry channel,
+                                           SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Returns the SilcChannelUser entry if the `client_entry' is joined on the
+    channel indicated by the `channel'. NULL if client is not joined on
+    the channel.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_perform_key_agreement.html b/docs/toolkit/manual/silcclient-silc_client_perform_key_agreement.html new file mode 100644 index 0000000..f168e78 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_perform_key_agreement.html @@ -0,0 +1,298 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_perform_key_agreement

    + + +SYNOPSIS + +
    
+    void
+    silc_client_perform_key_agreement(SilcClient client,
+                                      SilcClientConnection conn,
+                                      SilcClientEntry client_entry,
+                                      SilcClientConnectionParams *params,
+                                      SilcPublicKey public_key,
+                                      SilcPrivateKey private_key,
+                                      char *hostname, int port,
+                                      SilcKeyAgreementCallback completion,
+                                      void *context);
+
+
    +DESCRIPTION + +
    
+    Performs the key agreement protocol.  Application may use this to
+    initiate the key agreement protocol.  Usually this is called after
+    receiving the `key_agreement' client operation.
+
+    The `hostname' is the remote hostname (or IP address) and the `port'
+    is the remote port.  The `completion' callback with the `context' will
+    be called after the key agreement protocol.
+
+    The `params' is connection parameters and it may be used to define
+    the key agreement connection related parameters.  It may be NULL.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_perform_key_agreement_stream.html b/docs/toolkit/manual/silcclient-silc_client_perform_key_agreement_stream.html new file mode 100644 index 0000000..27aacb3 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_perform_key_agreement_stream.html @@ -0,0 +1,292 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_perform_key_agreement_stream

    + + +SYNOPSIS + +
    
+    void
+    silc_client_perform_key_agreement_stream(
+                                      SilcClient client,
+                                      SilcClientConnection conn,
+                                      SilcClientEntry client_entry,
+                                      SilcClientConnectionParams *params,
+                                      SilcPublicKey public_key,
+                                      SilcPrivateKey private_key,
+                                      SilcStream stream,
+                                      SilcKeyAgreementCallback completion,
+                                      void *context);
+
+
    +DESCRIPTION + +
    
+    Same as silc_client_perform_key_agreement but the caller has created
+    the connection to remote client.  The `stream' is the created
+    connection.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_private_message_key_is_set.html b/docs/toolkit/manual/silcclient-silc_client_private_message_key_is_set.html new file mode 100644 index 0000000..e2d7bb9 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_private_message_key_is_set.html @@ -0,0 +1,284 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_private_message_key_is_set

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_client_private_message_key_is_set(SilcClient client,
+                                           SilcClientConnection conn,
+                                           SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the private message key has been set for the client
+    entry indicated by `client_entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_private_message_wait.html b/docs/toolkit/manual/silcclient-silc_client_private_message_wait.html new file mode 100644 index 0000000..dd2f250 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_private_message_wait.html @@ -0,0 +1,300 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_private_message_wait

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_client_private_message_wait(SilcClient client,
+                                     SilcClientConnection conn,
+                                     SilcClientEntry client_entry,
+                                     SilcMessagePayload *payload);
+
+
    +DESCRIPTION + +
    
+    Blocks current thread or process until a private message has been
+    received from the remote client indicated by `client_entry'.  Before
+    private messages can be waited the silc_client_private_message_wait_init
+    must be called.  This function can be used from a thread to wait for
+    private message from the specified client.  Multiple threads can be
+    created to wait messages from multiple clients.  Any other private
+    message received from the connection indicated by `conn' will be
+    forwarded to the normal `private_message' client operation callback.
+    The private messages from `client_entry' will not be delivered to the
+    `private_message' client operation callback.
+
+    Returns TRUE and the received private message into `payload'.  The caller
+    must free the returned SilcMessagePayload.  If this function returns
+    FALSE the private messages cannot be waited anymore.  This happens
+    when some other thread calls silc_client_private_message_wait_uninit.
+    This returns FALSE also if silc_client_private_message_wait_init has
+    not been called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_private_message_wait_init.html b/docs/toolkit/manual/silcclient-silc_client_private_message_wait_init.html new file mode 100644 index 0000000..23fccd7 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_private_message_wait_init.html @@ -0,0 +1,289 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_private_message_wait_init

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_client_private_message_wait_init(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Initializes private message waiting functionality for the client
+    indicated by `client_entry'.  Once this is called private message
+    from remote connection indicated by `conn' for `client_entry' may
+    be waiter for, for example in a thread.  The function
+    silc_client_private_message_wait is used to block the current thread
+    until a private message is received from a specified client entry.
+    Return FALSE in case an internal error occurred.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_private_message_wait_uninit.html b/docs/toolkit/manual/silcclient-silc_client_private_message_wait_uninit.html new file mode 100644 index 0000000..3cdef16 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_private_message_wait_uninit.html @@ -0,0 +1,286 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_private_message_wait_uninit

    + + +SYNOPSIS + +
    
+    void
+    silc_client_private_message_wait_uninit(SilcClient client,
+                                            SilcClientConnection conn,
+                                            SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Unintializes private message waiting for client indicated by
+    `client_entry'.  After this call private message cannot be waited
+    anymore and silc_client_private_message_wait will return with FALSE
+    value.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_run.html b/docs/toolkit/manual/silcclient-silc_client_run.html new file mode 100644 index 0000000..515d251 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_run.html @@ -0,0 +1,282 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_run

    + + +SYNOPSIS + +
    
+    void silc_client_run(SilcClient client);
+
+
    +DESCRIPTION + +
    
+    Runs the client.  This starts the scheduler from the utility library.
+    When this functions returns the execution of the application is over.
+    The client must be initialized before calling this.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_run_one.html b/docs/toolkit/manual/silcclient-silc_client_run_one.html new file mode 100644 index 0000000..ffded3f --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_run_one.html @@ -0,0 +1,286 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_run_one

    + + +SYNOPSIS + +
    
+    void silc_client_run_one(SilcClient client);
+
+
    +DESCRIPTION + +
    
+    Runs the client and returns immeadiately. This function is used when
+    the SILC Client object indicated by the `client' is run under some
+    other scheduler, or event loop or main loop.  On GUI applications,
+    for example this may be desired to used to run the client under the
+    GUI application's main loop.  Typically the GUI application would
+    register an idle task that calls this function multiple times in
+    a second to quickly process the SILC specific data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_send_channel_message.html b/docs/toolkit/manual/silcclient-silc_client_send_channel_message.html new file mode 100644 index 0000000..d789b05 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_send_channel_message.html @@ -0,0 +1,303 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_send_channel_message

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_send_channel_message(SilcClient client,
+                                              SilcClientConnection conn,
+                                              SilcChannelEntry channel,
+                                              SilcChannelPrivateKey key,
+                                              SilcMessageFlags flags,
+                                              SilcHash hash,
+                                              unsigned char *data,
+                                              SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Sends encrypted message to the `channel'.  The plaintext message is
+    the `data' of `data_len' bytes in length.
+
+    If `key' is provided then that private channel message key is used to
+    encrypt the message.  If it is not provided and the `channel' does not
+    have SILC_CHANNEL_MODE_PRIVKEY set, the curent channel key is used
+    instead.  If the mode is set but `key' is NULL the key that was added
+    first as private channel message key will be used.
+
+    If the `flags' includes SILC_MESSAGE_FLAG_SIGNED the message will be
+    digitally signed with the SILC key pair associated with the `conn'.
+    In this case the `hash' pointer must be provided as well.
+
+    Returns TRUE if the message was sent, and FALSE if error occurred or
+    the sending is not allowed due to channel modes (like sending is
+    blocked).  This function is thread safe and channel messages can be
+    sent from multiple threads.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_send_key_agreement.html b/docs/toolkit/manual/silcclient-silc_client_send_key_agreement.html new file mode 100644 index 0000000..21f7ecc --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_send_key_agreement.html @@ -0,0 +1,329 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_send_key_agreement

    + + +SYNOPSIS + +
    
+    void silc_client_send_key_agreement(SilcClient client,
+                                        SilcClientConnection conn,
+                                        SilcClientEntry client_entry,
+                                        SilcClientConnectionParams *params,
+                                        SilcPublicKey public_key,
+                                        SilcPrivateKey private_key,
+                                        SilcKeyAgreementCallback completion,
+                                        void *context);
+
+
    +DESCRIPTION + +
    
+    Sends key agreement request to the remote client indicated by the
+    `client_entry'.
+
+    If `params' is non-NULL and it has the `local_ip' and `local_port' set
+    the caller will provide the connection endpoint for the key agreement
+    connection.  The `bind_ip' can be used to bind to that IP instead of
+    `local_ip'.  If the `udp' is set to TRUE the connection will be UDP
+    instead of TCP.  Caller may also set the `repository', `verify_notfound'
+    and `timeout_secs' fields in `params'.  Other fields are ignored.
+    If `params' is NULL, then the `client_entry' is expected to provide
+    the connection endpoint for us.  It is recommended the `timeout_secs'
+    is specified in case the remote client does not reply anything to
+    the request.
+
+    The `public_key' and `private_key' is our identity in the key agreement.
+
+    In case we do not provide the connection endpoint, we will receive
+    the `key_agreement' client operation when the remote send its own
+    key agreement request packet.  We may then there start the key
+    agreement with silc_client_perform_key_agreement.  If we provided the
+    the connection endpoint, the client operation will not be called.
+
+    There can be only one active key agreement for `client_entry'.  Old
+    key agreement may be aborted by calling silc_client_abort_key_agreement.
+
+
    +EXAMPLE + +
    
+    // Send key agreement request (we don't provide connection endpoint)
+    silc_client_send_key_agreement(client, conn, remote_client,
+                                   NULL, public_key, private_key,
+                                   my_keyagr_completion, my_context);
+
+    // Another example where we provide connection endpoint (TCP).
+    SilcClientConnectionParams params;
+    memset(&params, 0, sizeof(params));
+    params.local_ip = local_ip;
+    params.local_port = local_port;
+    params.timeout_secs = 60;
+    silc_client_send_key_agreement(client, conn, remote_client,
+                                   &params, public_key, private_key,
+                                   my_keyagr_completion, my_context);
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_send_private_message.html b/docs/toolkit/manual/silcclient-silc_client_send_private_message.html new file mode 100644 index 0000000..677c1ac --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_send_private_message.html @@ -0,0 +1,295 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_send_private_message

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_send_private_message(SilcClient client,
+                                              SilcClientConnection conn,
+                                              SilcClientEntry client_entry,
+                                              SilcMessageFlags flags,
+                                              SilcHash hash,
+                                              unsigned char *data,
+                                              SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Sends private message to remote client. If private message key has
+    not been set with this client then the message will be encrypted using
+    the session keys used in `conn' connection.  If the `flags' includes
+    SILC_MESSAGE_FLAG_SIGNED the message will be digitally signed with the
+    SILC key pair associated with `conn'.  In this case the caller must also
+    provide the `hash' pointer.
+
+    Returns TRUE if the message was sent, and FALSE if error occurred.
+    This function is thread safe and private messages can be sent from
+    multiple threads.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_set_away_message.html b/docs/toolkit/manual/silcclient-silc_client_set_away_message.html new file mode 100644 index 0000000..e00edc3 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_set_away_message.html @@ -0,0 +1,289 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_set_away_message

    + + +SYNOPSIS + +
    
+    SilcBool silc_client_set_away_message(SilcClient client,
+                                          SilcClientConnection conn,
+                                          char *message);
+
+
    +DESCRIPTION + +
    
+    Sets away `message'.  The away message may be set when the client's
+    mode is changed to SILC_UMODE_GONE and the client whishes to reply
+    to anyone who sends private message.  The `message' will be sent
+    automatically back to the the client who send private message.  If
+    away message is already set this replaces the old message with the
+    new one.  If `message' is NULL the old away message is removed.
+    The sender may freely free the memory of the `message'.  Returns
+    FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient-silc_client_stop.html b/docs/toolkit/manual/silcclient-silc_client_stop.html new file mode 100644 index 0000000..8b6d6c3 --- /dev/null +++ b/docs/toolkit/manual/silcclient-silc_client_stop.html @@ -0,0 +1,290 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_stop

    + + +SYNOPSIS + +
    
+    void silc_client_stop(SilcClient client, SilcClientStopped stopped,
+                          void *context);
+
+
    +DESCRIPTION + +
    
+    Stops the client. This is called to stop the client and thus to stop
+    the program.  The client context must be freed with the silc_client_free
+    function.  All connections that exist in this client must be closed
+    before calling this function.  Connections can be closed by calling
+    silc_client_close_connection.
+
+    The `stopped' will be called once the client and all connections have
+    finished.  The client may be freed after that.  Note that the `stopped'
+    won't be called before all connections have finished.  Setting the
+    callback is optional.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientConnectionStatus
    +SilcClientRunning
    +SilcClientStopped
    +SilcClientConnectCallback
    +SilcClient
    +SilcClientConnection
    +SilcChannelUser
    +SilcClientStats
    +SilcKeyAgreementStatus
    +SilcKeyAgreementCallback
    +SilcPrivateMessageKeys
    +SilcChannelPrivateKey
    +SilcAskPassphrase
    +SilcVerifyPublicKey
    +SilcGetAuthMeth
    +SilcClientMessageType
    +SilcClientOperations
    +SilcClientParams
    +silc_client_alloc
    +silc_client_free
    +silc_client_init
    +silc_client_run
    +silc_client_run_one
    +silc_client_stop
    +SilcClientConnectionParams
    +silc_client_connect_to_server
    +silc_client_connect_to_client
    +silc_client_key_exchange
    +silc_client_close_connection
    +silc_client_send_channel_message
    +silc_client_send_private_message
    +silc_client_private_message_wait_init
    +silc_client_private_message_wait_uninit
    +silc_client_private_message_wait
    +silc_client_on_channel
    +silc_client_command_call
    +SilcClientCommandReply
    +silc_client_command_send
    +silc_client_command_pending
    +silc_client_add_private_message_key
    +silc_client_add_private_message_key_ske
    +silc_client_del_private_message_key
    +silc_client_list_private_message_keys
    +silc_client_free_private_message_keys
    +silc_client_private_message_key_is_set
    +silc_client_add_channel_private_key
    +silc_client_del_channel_private_keys
    +silc_client_del_channel_private_key
    +silc_client_list_channel_private_keys
    +silc_client_current_channel_private_key
    +silc_client_send_key_agreement
    +silc_client_perform_key_agreement
    +silc_client_perform_key_agreement_stream
    +silc_client_abort_key_agreement
    +silc_client_set_away_message
    +SilcClientMonitorStatus
    +SilcClientFileError
    +SilcClientFileMonitor
    +SilcClientFileName
    +SilcClientFileAskName
    +silc_client_file_send
    +silc_client_file_receive
    +silc_client_file_close
    +silc_client_attribute_add
    +silc_client_attribute_del
    +silc_client_attributes_get
    +silc_client_attributes_request
    +silc_client_nickname_format
    +silc_client_nickname_parse
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient.html b/docs/toolkit/manual/silcclient.html new file mode 100644 index 0000000..5c516f5 --- /dev/null +++ b/docs/toolkit/manual/silcclient.html @@ -0,0 +1,307 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcclient.html + + + + +
    + +Client Library Interface
    Header: silcclient.h

    + + +DESCRIPTION + +
    
+ This interface defines the SILC Client Library API for the application.
+ The Client Library is a full featured SILC client without user interface.
+ A simple interface called SILC Client Operations (SilcClientOperations)
+ is provided for applications to implmeent the necessary functions to use
+ the client library.  The silcclient.h header file includes client library
+ API, such as command handling and message sending.  The silcclient_entry.h
+ header file includes entry handling, such as channel and user entry
+ handling.
+
+ Practically all functions in the Client Library API accepts SilcClient
+ and SilcClientConnection as their first two argument.  The first argument
+ is the actual SilcClient context and the second is the SilcClientConnection
+ context of the connection in question.  Application may create and handle
+ multiple connections in one SilcClient.  Connections can be created to
+ servers and other clients.
+
+ The Client Library support multiple threads and is threads safe if used
+ correctly.  Messages can be sent from multiple threads without any
+ locking.  Messages however are always received only in one thread unless
+ message waiting (see silc_client_private_message_wait as an example) is
+ used.  The threads can be turned on and off by giving a parameter to the
+ SilcClient.  When turned on, each new connection to remote host is always
+ executed in an own thread.  All tasks related to that connection are then
+ executed in that thread.  This means that client operation callbacks for
+ that connections may be called from threads and application will need to
+ employ concurrency control if the callbacks need to access shared data
+ in the application.  Messages are also received in that thread.
+
+
  • SilcClientConnectionStatus +
  • SilcClientRunning +
  • SilcClientStopped +
  • SilcClientConnectCallback +
  • SilcClient +
  • SilcClientConnection +
  • SilcChannelUser +
  • SilcClientStats +
  • SilcKeyAgreementStatus +
  • SilcKeyAgreementCallback +
  • SilcPrivateMessageKeys +
  • SilcChannelPrivateKey +
  • SilcAskPassphrase +
  • SilcVerifyPublicKey +
  • SilcGetAuthMeth +
  • SilcClientMessageType +
  • SilcClientOperations +
  • SilcClientParams +
  • silc_client_alloc +
  • silc_client_free +
  • silc_client_init +
  • silc_client_run +
  • silc_client_run_one +
  • silc_client_stop +
  • SilcClientConnectionParams +
  • silc_client_connect_to_server +
  • silc_client_connect_to_client +
  • silc_client_key_exchange +
  • silc_client_close_connection +
  • silc_client_send_channel_message +
  • silc_client_send_private_message +
  • silc_client_private_message_wait_init +
  • silc_client_private_message_wait_uninit +
  • silc_client_private_message_wait +
  • silc_client_on_channel +
  • silc_client_command_call +
  • SilcClientCommandReply +
  • silc_client_command_send +
  • silc_client_command_pending +
  • silc_client_add_private_message_key +
  • silc_client_add_private_message_key_ske +
  • silc_client_del_private_message_key +
  • silc_client_list_private_message_keys +
  • silc_client_free_private_message_keys +
  • silc_client_private_message_key_is_set +
  • silc_client_add_channel_private_key +
  • silc_client_del_channel_private_keys +
  • silc_client_del_channel_private_key +
  • silc_client_list_channel_private_keys +
  • silc_client_current_channel_private_key +
  • silc_client_send_key_agreement +
  • silc_client_perform_key_agreement +
  • silc_client_perform_key_agreement_stream +
  • silc_client_abort_key_agreement +
  • silc_client_set_away_message +
  • SilcClientMonitorStatus +
  • SilcClientFileError +
  • SilcClientFileMonitor +
  • SilcClientFileName +
  • SilcClientFileAskName +
  • silc_client_file_send +
  • silc_client_file_receive +
  • silc_client_file_close +
  • silc_client_attribute_add +
  • silc_client_attribute_del +
  • silc_client_attributes_get +
  • silc_client_attributes_request +
  • silc_client_nickname_format +
  • silc_client_nickname_parse + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient.xref b/docs/toolkit/manual/silcclient.xref new file mode 100644 index 0000000..a59bad5 --- /dev/null +++ b/docs/toolkit/manual/silcclient.xref @@ -0,0 +1,76 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcclient.h" "/home/priikone/silc1/doc/toolkit/silcclient.html" 0 + "Client Library Interface" "/home/priikone/silc1/doc/toolkit/silcclient.html" 1 + "SilcClientConnectionStatus" "/home/priikone/silc1/doc/toolkit/silcclient.html" 8 + "SilcClientRunning" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientStopped" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientConnectCallback" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClient" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "SilcClientConnection" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "SilcChannelUser" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "SilcClientStats" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "SilcKeyAgreementStatus" "/home/priikone/silc1/doc/toolkit/silcclient.html" 8 + "SilcKeyAgreementCallback" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcPrivateMessageKeys" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "SilcChannelPrivateKey" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "SilcAskPassphrase" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcVerifyPublicKey" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcGetAuthMeth" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientMessageType" "/home/priikone/silc1/doc/toolkit/silcclient.html" 8 + "SilcClientOperations" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "SilcClientParams" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "silc_client_alloc" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_free" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_init" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_run" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_run_one" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_stop" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientConnectionParams" "/home/priikone/silc1/doc/toolkit/silcclient.html" 5 + "silc_client_connect_to_server" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_connect_to_client" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_key_exchange" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_close_connection" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_send_channel_message" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_send_private_message" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_private_message_wait_init" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_private_message_wait_uninit" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_private_message_wait" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_on_channel" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_command_call" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientCommandReply" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_command_send" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_command_pending" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_add_private_message_key" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_add_private_message_key_ske" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_del_private_message_key" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_list_private_message_keys" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_free_private_message_keys" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_private_message_key_is_set" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_add_channel_private_key" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_del_channel_private_keys" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_del_channel_private_key" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_list_channel_private_keys" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_current_channel_private_key" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_send_key_agreement" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_perform_key_agreement" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_perform_key_agreement_stream" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_abort_key_agreement" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_set_away_message" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientMonitorStatus" "/home/priikone/silc1/doc/toolkit/silcclient.html" 8 + "SilcClientFileError" "/home/priikone/silc1/doc/toolkit/silcclient.html" 8 + "SilcClientFileMonitor" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientFileName" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "SilcClientFileAskName" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_file_send" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_file_receive" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_file_close" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_attribute_add" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_attribute_del" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_attributes_get" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_attributes_request" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_nickname_format" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + "silc_client_nickname_parse" "/home/priikone/silc1/doc/toolkit/silcclient.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcclient_entry-SilcChannelEntry.html b/docs/toolkit/manual/silcclient_entry-SilcChannelEntry.html new file mode 100644 index 0000000..ddd9a83 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-SilcChannelEntry.html @@ -0,0 +1,279 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcChannelEntry

    + + +NAME + +
    
+    typedef struct SilcChannelEntryStruct { ... } *SilcChannelEntry;
+
+
    +DESCRIPTION + +
    
+    This structure represents a channel in the SILC network.  All
+    channels that the client are aware of or have joined in will be
+    represented as SilcChannelEntry.  The structure includes information
+    about the channel.  All strings in the structure are UTF-8 encoded.
+
+    Application may store its own pointer into the context pointer in
+    this structure.
+
+
    +NOTES + +
    
+    If application stores the SilcChannelEntry it must always take
+    a reference of it by calling silc_client_ref_channel function.  The
+    reference must be released after it is not needed anymore by calling
+    silc_client_unref_channel function.
+
+
    +SOURCE + +
        struct SilcChannelEntryStruct {
+      char *channel_name;                /* Channel name */
+      char server[256 + 1];              /* SILC server name */
+      char *topic;                       /* Current topic, may be NULL */
+      SilcPublicKey founder_key;         /* Founder key, may be NULL */
+      SilcDList channel_pubkeys;         /* Channel public keys, may be NULL */
+      SilcChannelID id;                  /* Channel ID */
+      SilcUInt32 mode;                   /* Channel mode, ChannelModes. */
+      SilcUInt32 user_limit;             /* User limit on channel */
+      SilcHashTable user_list;           /* Joined users.  Key to hash table is
+                                            SilcClientEntry, context is
+                                            SilcChannelUser. */
+      const char *cipher;                /* Current channel cipher algorithm*/
+      const char *hmac;                  /* Current channel HMAC algorithm */
+    
+      void *context;                     /* Application specific context */
+      SilcChannelEntryInternal internal;
+    };
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-SilcClientEntry.html b/docs/toolkit/manual/silcclient_entry-SilcClientEntry.html new file mode 100644 index 0000000..280d773 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-SilcClientEntry.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClientEntry

    + + +NAME + +
    
+    typedef struct SilcClientEntryStruct { ... } *SilcClientEntry;
+
+
    +DESCRIPTION + +
    
+    This structure represents a client or a user in the SILC network.
+    The local user has this structure also and it can be accessed from
+    SilcClientConnection structure.  All other users in the SILC network
+    that are accessed using the Client Library routines will have their
+    own SilcClientEntry structure.  For example, when finding users by
+    their nickname the Client Library returns this structure back to
+    the application.  All strings in the structure are UTF-8 encoded.
+
+    Application may store its own pointer into the context pointer in
+    this structure.
+
+
    +NOTES + +
    
+    If application wants to store nickname or any of the other strings
+    it should always duplicated them.
+
+    None of the string arrays are set if the first character is '\0'.
+    All string arrays are always zero ('\0') terminated.
+
+    If application stores the SilcClientEntry it must always take
+    a reference of it by calling silc_client_ref_client function.  The
+    reference must be released after it is not needed anymore by calling
+    silc_client_unref_client function.
+
+
    +SOURCE + +
        struct SilcClientEntryStruct {
+      char nickname[256 + 1];            /* Nickname */
+      char username[128 + 1];            /* Username */
+      char hostname[256 + 1];            /* Hostname */
+      char server  [256 + 1];            /* SILC server name */
+      char *realname;                    /* Realname (userinfo) */
+      char *nickname_normalized;         /* Normalized nickname */
+    
+      SilcClientID id;                   /* The Client ID */
+      SilcUInt32 mode;                   /* User mode in SILC, see SilcUserMode */
+      SilcPublicKey public_key;          /* User's public key, may be NULL */
+      SilcHashTable channels;            /* Channels client has joined */
+      SilcDList attrs;                   /* Requested Attributes (maybe NULL) */
+      unsigned char fingerprint[20];     /* SHA-1 fingerprint of the public key */
+    
+      void *context;                     /* Application specific context */
+      SilcClientEntryInternal internal;
+    };
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-SilcGetChannelCallback.html b/docs/toolkit/manual/silcclient_entry-SilcGetChannelCallback.html new file mode 100644 index 0000000..621c0fe --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-SilcGetChannelCallback.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcGetChannelCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcGetChannelCallback)(SilcClient client,
+                                           SilcClientConnection conn,
+                                           SilcStatus status,
+                                           SilcDList channels,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    Callback function given to various channel resolving functions.
+    The found entries are included in the `channels' list and each entry
+    in the list is SilcChannelEntry.  If `channels' is NULL then no such
+    channel exist in the network and the `status' will indicate the error.
+
+
    +NOTES + +
    
+    If the application stores any of the SilcChannelEntry pointers from
+    the `channels' list it must reference it with silc_client_ref_channel
+    function.
+
+    Application must not free the returned `channels' list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-SilcGetClientCallback.html b/docs/toolkit/manual/silcclient_entry-SilcGetClientCallback.html new file mode 100644 index 0000000..adebfb4 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-SilcGetClientCallback.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcGetClientCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcGetClientCallback)(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcStatus status,
+                                          SilcDList clients,
+                                          void *context);
+
+
    +DESCRIPTION + +
    
+    Callback function given to various client search functions.  The
+    found entries are allocated into the `clients' list.  The list must
+    not be freed by the receiver, the library will free it later.  If the
+    `clients' is NULL, no such clients exist in the SILC network, and
+    the `status' will include the error.  Each entry in the `clients'
+    is SilcClientEntry.
+
+
    +NOTES + +
    
+    If the application stores any of the SilcClientEntry pointers from
+    the `clients' list it must reference it with silc_client_ref_client
+    function.
+
+    Application must not free the returned `clients' list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-SilcGetServerCallback.html b/docs/toolkit/manual/silcclient_entry-SilcGetServerCallback.html new file mode 100644 index 0000000..27ddd94 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-SilcGetServerCallback.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcGetServerCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcGetServerCallback)(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcStatus status,
+                                          SilcDList servers,
+                                          void *context);
+
+
    +DESCRIPTION + +
    
+    Callback function given to various server resolving functions.
+    The found entries are included in the `servers' list and each entry
+    in the list is SilcServerEntry.  If `server' is NULL then no such
+    server exist in the network and the `status' will indicate the error.
+
+
    +NOTES + +
    
+    If the application stores any of the SilcServerEntry pointers from
+    the `server' list it must reference it with silc_client_ref_server
+    function.
+
+    Application must not free the returned `server' list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-SilcServerEntry.html b/docs/toolkit/manual/silcclient_entry-SilcServerEntry.html new file mode 100644 index 0000000..4f2b8f0 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-SilcServerEntry.html @@ -0,0 +1,273 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcServerEntry

    + + +NAME + +
    
+    typedef struct SilcServerEntryStruct { ... } *SilcServerEntry;
+
+
    +DESCRIPTION + +
    
+    This structure represents a server in the SILC network.  All servers
+    that the client is aware of and have for example resolved with
+    SILC_COMMAND_INFO command have their on SilcServerEntry structure.
+    Server's public key is present only if it has been retrieved using
+    SILC_COMMAND_GETKEY command.  All strings in the structure are UTF-8
+    encoded.
+
+    Application may store its own pointer into the context pointer in
+    this structure.
+
+
    +NOTES + +
    
+    If application stores the SilcServerEntry it must always take
+    a reference of it by calling silc_client_ref_server function.  The
+    reference must be released after it is not needed anymore by calling
+    silc_client_unref_server function.
+
+
    +SOURCE + +
        struct SilcServerEntryStruct {
+      /* General information */
+      char *server_name;                 /* Server name */
+      char *server_info;                 /* Server info */
+      SilcServerID id;                   /* Server ID */
+      SilcPublicKey public_key;          /* Server public key, may be NULL */
+    
+      void *context;                     /* Application specific context */
+      SilcServerEntryInternal internal;
+    };
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_channel.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel.html new file mode 100644 index 0000000..bc20d86 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_channel

    + + +SYNOPSIS + +
    
+    SilcChannelEntry silc_client_get_channel(SilcClient client,
+                                             SilcClientConnection conn,
+                                             char *channel_name);
+
+
    +DESCRIPTION + +
    
+    Finds entry for channel by the channel name. Returns the entry or NULL
+    if the entry was not found. It is found only if the client is joined
+    to the channel.  Use silc_client_get_channel_resolve or
+    silc_client_get_channel_by_id_resolve to resolve channel that client
+    is not joined.
+
+
    +NOTES + +
    
+    The returned SilcChannelEntry has been referenced by the library and
+    the caller must call silc_client_unref_channel after the entry is not
+    needed anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id.html new file mode 100644 index 0000000..9954dea --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_channel_by_id

    + + +SYNOPSIS + +
    
+    SilcChannelEntry
+    silc_client_get_channel_by_id(SilcClient client,
+                                  SilcClientConnection conn,
+                                  SilcChannelID *channel_id);
+
+
    +DESCRIPTION + +
    
+    Finds channel entry by the channel ID. Returns the entry or NULL
+    if the entry was not found.  This checks the local cache and does
+    not resolve anything from server.
+
+
    +NOTES + +
    
+    The returned SilcChannelEntry has been referenced by the library and
+    the caller must call silc_client_unref_channel after the entry is not
+    needed anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id_resolve.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id_resolve.html new file mode 100644 index 0000000..d5c7979 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_by_id_resolve.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_channel_by_id_resolve

    + + +SYNOPSIS + +
    
+    SilcUInt16
+    silc_client_get_channel_by_id_resolve(SilcClient client,
+                                          SilcClientConnection conn,
+                                          SilcChannelID *channel_id,
+                                          SilcGetClientCallback completion,
+                                          void *context);
+
+
    +DESCRIPTION + +
    
+    Resolves the channel information (its name mainly) from the server
+    by the `channel_id'. Use this only if you know that you do not have
+    the entry cached locally. The resolving is done with IDENTIFY command.
+
+    Returns command identifier for the resolving.  It can be used to attach
+    a pending command to it, if needed.  Returns 0 on error.
+
+    Note that users on the channel are not resolved at the same time.
+    Use for example USERS command to resolve all users on a channel.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_resolve.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_resolve.html new file mode 100644 index 0000000..39193e8 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_channel_resolve.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_channel_resolve

    + + +SYNOPSIS + +
    
+    void silc_client_get_channel_resolve(SilcClient client,
+                                         SilcClientConnection conn,
+                                         char *channel_name,
+                                         SilcGetChannelCallback completion,
+                                         void *context);
+
+
    +DESCRIPTION + +
    
+    Resolves entry for channel by the channel name from the server.
+    The resolving is done with IDENTIFY command. Note that users on
+    the channel are not resolved at the same time. Use for example
+    USERS command to resolve all users on a channel.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id.html new file mode 100644 index 0000000..2edc86a --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_client_by_id

    + + +SYNOPSIS + +
    
+    SilcClientEntry silc_client_get_client_by_id(SilcClient client,
+                                                 SilcClientConnection conn,
+                                                 SilcClientID *client_id);
+
+
    +DESCRIPTION + +
    
+    Find client entry by the client's ID.  Returns the entry or NULL
+    if the entry was not found.  This checks the local cache and does
+    not resolve anything from server.
+
+
    +NOTES + +
    
+    The returned SilcClientEntry has been referenced by the library and
+    the caller must call silc_client_unref_client after the entry is not
+    needed anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id_resolve.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id_resolve.html new file mode 100644 index 0000000..f04654b --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_client_by_id_resolve.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_client_by_id_resolve

    + + +SYNOPSIS + +
    
+    SilcUInt16
+    silc_client_get_client_by_id_resolve(SilcClient client,
+                                         SilcClientConnection conn,
+                                         SilcClientID *client_id,
+                                         SilcBuffer attributes,
+                                         SilcGetClientCallback completion,
+                                         void *context);
+
+
    +DESCRIPTION + +
    
+    Same as silc_client_get_client_by_id but will always resolve the
+    information from the server. Use this only if you know that you
+    do not have the entry and the only thing you know about the client
+    is its ID. When server returns the client information it will be
+    cache and can be accessed locally at a later time. The resolving
+    is done by sending WHOIS command.
+
+    Returns command identifier for the resolving.  It can be used to attach
+    a pending command to it, if needed.  Returns 0 on error.
+
+    If the `attributes' is non-NULL then the buffer includes Requested
+    Attributes which can be used to fetch very detailed information
+    about the user. If it is NULL then only normal WHOIS query is
+    made (for more information about attributes see SilcAttribute).
+    Caller may create the `attributes' with silc_client_attributes_request
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_clients.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_clients.html new file mode 100644 index 0000000..1799d0e --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_clients.html @@ -0,0 +1,274 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_clients

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_client_get_clients(SilcClient client,
+                                       SilcClientConnection conn,
+                                       const char *nickname,
+                                       const char *server,
+                                       SilcGetClientCallback completion,
+                                       void *context);
+
+
    +DESCRIPTION + +
    
+    Finds client entry or entries by the `nickname' and `server'. The
+    completion callback will be called when the client entries has been
+    found.  After the server returns the client information it is cached
+    and can be accesses locally at a later time.  The resolving is done
+    with IDENTIFY command.  The `server' may be NULL.  The server
+    associated with the nickname may be in the `nickname' (nick@server).
+    The `nickname' may also be a formatted nickname in which case the
+    formatting is ignored and the base nickname is used.  If the nickname
+    is formatted it must be formatted as defined in SilcClientParams.
+    Returns 0 on error and the command identifier used with the command
+    otherwise.
+
+
    +NOTES + +
    
+    This function is always asynchronous and resolves the client
+    information from the server.  Thus, if you already know the client
+    information then use the silc_client_get_client_by_id function to
+    get the client entry since this function may be very slow and should
+    be used only to initially get the client entries.
+
+    This function resolves only the relevant information (user's nickname
+    and username).  It does not resolve for example user's real name,
+    joined channel list or other information.  To resolve all the details
+    use silc_client_get_clients_whois instead.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_clients_local.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_clients_local.html new file mode 100644 index 0000000..ffcb591 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_clients_local.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_clients_local

    + + +SYNOPSIS + +
    
+    SilcDList silc_client_get_clients_local(SilcClient client,
+                                            SilcClientConnection conn,
+                                            const char *nickname,
+                                            SilcBool return_all);
+
+
    +DESCRIPTION + +
    
+    Same as silc_client_get_clients function but does not resolve anything
+    from the server.  This checks local cache and returns matching clients
+    from the local cache.  If none was found this returns NULL.  The
+    `nickname' is the nickname to find and it may be a formatted nickname
+    or a base nickname.  If the `return_all' is TRUE this call will return
+    all clients matching the `nickname' base.  If it is FALSE this will
+    return the exact match if `nickname' is a formatted nickname or the
+    first matching nickname if it is not formatted.  The formatted nickname
+    must of the format specified in SilcClientParams.  The caller must free
+    the returned list by calling silc_client_list_free function.
+
+
    +NOTES + +
    
+    If the application stores any of the SilcClientEntry pointers from
+    the returned list it must reference it with silc_client_ref_client
+    function.
+
+    Application must free the returned list with silc_client_list_free
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_clients_whois.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_clients_whois.html new file mode 100644 index 0000000..50f18f3 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_clients_whois.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_clients_whois

    + + +SYNOPSIS + +
    
+    SilcUInt16
+    silc_client_get_clients_whois(SilcClient client,
+                                  SilcClientConnection conn,
+                                  const char *nickname,
+                                  const char *server,
+                                  SilcBuffer attributes,
+                                  SilcGetClientCallback completion,
+                                  void *context);
+
+
    +DESCRIPTION + +
    
+    Finds client entry or entries by the `nickname' and `server'. The
+    completion callback will be called when the client entries has been
+    found.  After the server returns the client information it is cached
+    and can be accesses locally at a later time.  The resolving is done
+    with WHOIS command.  The `server' may be NULL.  The server
+    associated with the nickname may be in the `nickname' (nick@server).
+    The `nickname' may also be a formatted nickname in which case the
+    formatting is ignored and the base nickname is used.  If the nickname
+    is formatted it must be formatted as defined in SilcClientParams.
+    Returns 0 on error and the command identifier used with the command
+    otherwise.
+
+    If the `attributes' is non-NULL then the buffer includes Requested
+    Attributes which can be used to fetch very detailed information
+    about the user. If it is NULL then only normal WHOIS query is
+    made (for more information about attributes see SilcAttribute).
+    Caller may create the `attributes' with silc_client_attributes_request
+    function.
+
+
    +NOTES + +
    
+    The resolving is done with WHOIS command.  For this reason this
+    command may take a long time because it resolves detailed user
+    information.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_server.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_server.html new file mode 100644 index 0000000..8325f71 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_server.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_server

    + + +SYNOPSIS + +
    
+    SilcServerEntry silc_client_get_server(SilcClient client,
+                                           SilcClientConnection conn,
+                                           char *server_name)
+
+
    +DESCRIPTION + +
    
+    Finds entry for server by the server name. Returns the entry or NULL
+    if the entry was not found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id.html new file mode 100644 index 0000000..42a9f5d --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_server_by_id

    + + +SYNOPSIS + +
    
+    SilcServerEntry silc_client_get_server_by_id(SilcClient client,
+                                                 SilcClientConnection conn,
+                                                 SilcServerID *server_id);
+
+
    +DESCRIPTION + +
    
+    Finds entry for server by the server ID. Returns the entry or NULL
+    if the entry was not found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id_resolve.html b/docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id_resolve.html new file mode 100644 index 0000000..4673f10 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_get_server_by_id_resolve.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_get_server_by_id_resolve

    + + +SYNOPSIS + +
    
+    SilcUInt16
+    silc_client_get_server_by_id_resolve(SilcClient client,
+                                         SilcClientConnection conn,
+                                         SilcServerID *server_id,
+                                         SilcGetServerCallback completion,
+                                         void *context);
+
+
    +DESCRIPTION + +
    
+    Resolves the server information by the `server_id'.  The resolved
+    server is returned into the `completion' callback.
+
+    Returns command identifier for the resolving.  It can be used to attach
+    a pending command to it, if needed.  Returns 0 on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_list_free.html b/docs/toolkit/manual/silcclient_entry-silc_client_list_free.html new file mode 100644 index 0000000..8a6788f --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_list_free.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_list_free

    + + +SYNOPSIS + +
    
+    void silc_client_list_free(SilcClient client,
+                               SilcClientConnection conn,
+                               SilcDList client_list);
+
+
    +DESCRIPTION + +
    
+    Free's client entry list that has been returned by various library
+    routines.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_list_free_channel.html b/docs/toolkit/manual/silcclient_entry-silc_client_list_free_channel.html new file mode 100644 index 0000000..80604bb --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_list_free_channel.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_list_free_channel

    + + +SYNOPSIS + +
    
+    void silc_client_list_free_channel(SilcClient client,
+                                       SilcClientConnection conn,
+                                       SilcDList channel_list);
+
+
    +DESCRIPTION + +
    
+    Free's channel entry list that has been returned by various library
+    routines.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_list_free_server.html b/docs/toolkit/manual/silcclient_entry-silc_client_list_free_server.html new file mode 100644 index 0000000..67e46a9 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_list_free_server.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_list_free_server

    + + +SYNOPSIS + +
    
+    void silc_client_list_free_server(SilcClient client,
+                                      SilcClientConnection conn,
+                                      SilcDList server_list);
+
+
    +DESCRIPTION + +
    
+    Free's server entry list that has been returned by various library
+    routines.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_lock_channel.html b/docs/toolkit/manual/silcclient_entry-silc_client_lock_channel.html new file mode 100644 index 0000000..3823885 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_lock_channel.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_lock_channel

    + + +SYNOPSIS + +
    
+    void silc_client_lock_channel(SilcChannelEntry channel_entry);
+
+
    +DESCRIPTION + +
    
+    Acquires lock for the channel entry indicate by `channel_entry'.  When
+    application wants to access `channel_entry' it must lock the entry
+    before reading any data from the `channel_entry'.  The lock must be
+    unlocked with silc_client_unlock_channel.
+
+
    +NOTES + +
    
+    The entry must be unlocked before calling any Client Library API
+    functions where the entry is given as argument, unless otherwise stated.
+
+    The entry should not be locked for long periods of time.  For example,
+    it is not appropriate to hold the lock while waiting user interface to
+    be drawn.  The appropriate way is to read the data and duplicate it if
+    necessary, unlock the entry, then draw on the user interface.
+
+    This function is not needed if application is not multithreaded.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_lock_client.html b/docs/toolkit/manual/silcclient_entry-silc_client_lock_client.html new file mode 100644 index 0000000..005270f --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_lock_client.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_lock_client

    + + +SYNOPSIS + +
    
+    void silc_client_lock_client(SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Acquires lock for the client entry indicate by `client_entry'.  When
+    application wants to access `client_entry' it must lock the entry
+    before reading any data from the `client_entry'.  The lock must be
+    unlocked with silc_client_unlock_client.
+
+
    +NOTES + +
    
+    The entry must be unlocked before calling any Client Library API
+    functions where the entry is given as argument, unless otherwise stated.
+
+    The entry should not be locked for long periods of time.  For example,
+    it is not appropriate to hold the lock while waiting user interface to
+    be drawn.  The appropriate way is to read the data and duplicate it if
+    necessary, unlock the entry, then draw on the user interface.
+
+    This function is not needed if application is not multithreaded.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_lock_server.html b/docs/toolkit/manual/silcclient_entry-silc_client_lock_server.html new file mode 100644 index 0000000..3eb033f --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_lock_server.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_lock_server

    + + +SYNOPSIS + +
    
+    void silc_client_lock_server(SilcServerEntry server_entry);
+
+
    +DESCRIPTION + +
    
+    Acquires lock for the server entry indicate by `server_entry'.  When
+    application wants to access `server_entry' it must lock the entry
+    before reading any data from the `server_entry'.  The lock must be
+    unlocked with silc_client_unlock_server.
+
+
    +NOTES + +
    
+    The entry must be unlocked before calling any Client Library API
+    functions where the entry is given as argument, unless otherwise stated.
+
+    The entry should not be locked for long periods of time.  For example,
+    it is not appropriate to hold the lock while waiting user interface to
+    be drawn.  The appropriate way is to read the data and duplicate it if
+    necessary, unlock the entry, then draw on the user interface.
+
+    This function is not needed if application is not multithreaded.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_ref_channel.html b/docs/toolkit/manual/silcclient_entry-silc_client_ref_channel.html new file mode 100644 index 0000000..dafe82c --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_ref_channel.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_ref_channel

    + + +SYNOPSIS + +
    
+    SilcChannelEntry
+    silc_client_ref_channel(SilcClient client,
+                            SilcClientConnection conn,
+                            SilcChannelEntry channel_entry);
+
+
    +DESCRIPTION + +
    
+    Takes a reference of the channel entry indicated by `channel_entry'
+    The reference must be released by calling silc_client_unref_channel
+    after it is not needed anymore.  Returns `channel_entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_ref_client.html b/docs/toolkit/manual/silcclient_entry-silc_client_ref_client.html new file mode 100644 index 0000000..8c17f39 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_ref_client.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_ref_client

    + + +SYNOPSIS + +
    
+    SilcClientEntry
+    silc_client_ref_client(SilcClient client,
+                           SilcClientConnection conn,
+                           SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Takes a reference of the client entry indicated by `client_entry'
+    The reference must be released by calling silc_client_unref_client
+    after it is not needed anymore.  Returns `client_entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_ref_server.html b/docs/toolkit/manual/silcclient_entry-silc_client_ref_server.html new file mode 100644 index 0000000..140b320 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_ref_server.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_ref_server

    + + +SYNOPSIS + +
    
+    SilcServerEntry
+    silc_client_ref_server(SilcClient client,
+                           SilcClientConnection conn,
+                           SilcServerEntry server_entry);
+
+
    +DESCRIPTION + +
    
+    Takes a reference of the server entry indicated by `server_entry'
+    The reference must be released by calling silc_client_unref_server
+    after it is not needed anymore.  Returns `server_entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_unlock_channel.html b/docs/toolkit/manual/silcclient_entry-silc_client_unlock_channel.html new file mode 100644 index 0000000..5fe5565 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_unlock_channel.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_unlock_channel

    + + +SYNOPSIS + +
    
+    void silc_client_unlock_channel(SilcChannelEntry channel_entry);
+
+
    +DESCRIPTION + +
    
+    Releases the lock acquired with silc_client_lock_channel.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_unlock_client.html b/docs/toolkit/manual/silcclient_entry-silc_client_unlock_client.html new file mode 100644 index 0000000..de6fd5d --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_unlock_client.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_unlock_client

    + + +SYNOPSIS + +
    
+    void silc_client_unlock_client(SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Releases the lock acquired with silc_client_lock_client.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_unlock_server.html b/docs/toolkit/manual/silcclient_entry-silc_client_unlock_server.html new file mode 100644 index 0000000..ffcdeb7 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_unlock_server.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_unlock_server

    + + +SYNOPSIS + +
    
+    void silc_client_unlock_server(SilcServerEntry server_entry);
+
+
    +DESCRIPTION + +
    
+    Releases the lock acquired with silc_client_lock_server.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_unref_channel.html b/docs/toolkit/manual/silcclient_entry-silc_client_unref_channel.html new file mode 100644 index 0000000..29dac95 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_unref_channel.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_unref_channel

    + + +SYNOPSIS + +
    
+    void silc_client_unref_channel(SilcClient client,
+                                   SilcClientConnection conn,
+                                   SilcChannelEntry channel_entry);
+
+
    +DESCRIPTION + +
    
+    Releases the channel entry reference indicated by `channel_entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_unref_client.html b/docs/toolkit/manual/silcclient_entry-silc_client_unref_client.html new file mode 100644 index 0000000..a4647db --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_unref_client.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_unref_client

    + + +SYNOPSIS + +
    
+    void silc_client_unref_client(SilcClient client,
+                                  SilcClientConnection conn,
+                                  SilcClientEntry client_entry);
+
+
    +DESCRIPTION + +
    
+    Releases the client entry reference indicated by `client_entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry-silc_client_unref_server.html b/docs/toolkit/manual/silcclient_entry-silc_client_unref_server.html new file mode 100644 index 0000000..efe50da --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry-silc_client_unref_server.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_client_unref_server

    + + +SYNOPSIS + +
    
+    void silc_client_unref_server(SilcClient client,
+                                  SilcClientConnection conn,
+                                  SilcServerEntry server_entry);
+
+
    +DESCRIPTION + +
    
+    Releases the server entry reference indicated by `server_entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Client Library Interface
    +SilcClientEntry
    +SilcChannelEntry
    +SilcServerEntry
    +SilcGetClientCallback
    +silc_client_lock_client
    +silc_client_unlock_client
    +silc_client_ref_client
    +silc_client_unref_client
    +silc_client_list_free
    +silc_client_get_clients
    +silc_client_get_clients_whois
    +silc_client_get_clients_local
    +silc_client_get_client_by_id
    +silc_client_get_client_by_id_resolve
    +SilcGetChannelCallback
    +silc_client_lock_channel
    +silc_client_unlock_channel
    +silc_client_ref_channel
    +silc_client_unref_channel
    +silc_client_list_free_channel
    +silc_client_get_channel
    +silc_client_get_channel_resolve
    +silc_client_get_channel_by_id
    +silc_client_get_channel_by_id_resolve
    +SilcGetServerCallback
    +silc_client_lock_server
    +silc_client_unlock_server
    +silc_client_ref_server
    +silc_client_unref_server
    +silc_client_list_free_server
    +silc_client_get_server
    +silc_client_get_server_by_id
    +silc_client_get_server_by_id_resolve
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry.html b/docs/toolkit/manual/silcclient_entry.html new file mode 100644 index 0000000..a7081ab --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcclient_entry.html + + + + +
    + +Client Library Interface
    Header: silcclient_entry.h

    + + +DESCRIPTION + +
    
+ This header file includes the SilcClientEntry, SilcChannelEntry and
+ SilcServer entry structures and various routines to search, resolve and
+ handle these structures.
+
+ All entries (SilcClientEntry, SilcChannelEntry and SilcServerEntry) are
+ reference counted.  If application wishes to save an entry pointer it must
+ always first acquire a reference.  The reference must be released once the
+ entry is not needed anymore.  If application wants to read any data from
+ the entry structure it must first lock the entry.  This protects access to
+ the entries in multithreaded environment.  If threads are not used, locking
+ the entries is not needed.  They however still must be referenced even
+ when threads are not used.
+
+
  • SilcClientEntry +
  • SilcChannelEntry +
  • SilcServerEntry +
  • SilcGetClientCallback +
  • silc_client_lock_client +
  • silc_client_unlock_client +
  • silc_client_ref_client +
  • silc_client_unref_client +
  • silc_client_list_free +
  • silc_client_get_clients +
  • silc_client_get_clients_whois +
  • silc_client_get_clients_local +
  • silc_client_get_client_by_id +
  • silc_client_get_client_by_id_resolve +
  • SilcGetChannelCallback +
  • silc_client_lock_channel +
  • silc_client_unlock_channel +
  • silc_client_ref_channel +
  • silc_client_unref_channel +
  • silc_client_list_free_channel +
  • silc_client_get_channel +
  • silc_client_get_channel_resolve +
  • silc_client_get_channel_by_id +
  • silc_client_get_channel_by_id_resolve +
  • SilcGetServerCallback +
  • silc_client_lock_server +
  • silc_client_unlock_server +
  • silc_client_ref_server +
  • silc_client_unref_server +
  • silc_client_list_free_server +
  • silc_client_get_server +
  • silc_client_get_server_by_id +
  • silc_client_get_server_by_id_resolve + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_entry.xref b/docs/toolkit/manual/silcclient_entry.xref new file mode 100644 index 0000000..2d0afd9 --- /dev/null +++ b/docs/toolkit/manual/silcclient_entry.xref @@ -0,0 +1,40 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcclient_entry.h" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 0 + "Client Library Interface" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 1 + "SilcClientEntry" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 5 + "SilcChannelEntry" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 5 + "SilcServerEntry" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 5 + "SilcGetClientCallback" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_lock_client" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_unlock_client" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_ref_client" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_unref_client" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_list_free" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_clients" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_clients_whois" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_clients_local" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_client_by_id" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_client_by_id_resolve" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "SilcGetChannelCallback" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_lock_channel" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_unlock_channel" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_ref_channel" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_unref_channel" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_list_free_channel" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_channel" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_channel_resolve" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_channel_by_id" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_channel_by_id_resolve" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "SilcGetServerCallback" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_lock_server" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_unlock_server" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_ref_server" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_unref_server" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_list_free_server" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_server" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_server_by_id" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + "silc_client_get_server_by_id_resolve" "/home/priikone/silc1/doc/toolkit/silcclient_entry.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcclient_unicode.html b/docs/toolkit/manual/silcclient_unicode.html new file mode 100644 index 0000000..27d3548 --- /dev/null +++ b/docs/toolkit/manual/silcclient_unicode.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Unicode and UTF-8 Strings in Client Library + +
     
    +This document describes how the client library handles UTF-8 encoded +strings. By default all strings in the SILC protocol are UTF-8 encoded. +All strings that are sent to server and strings that are received from the +server are always UTF-8 encoded. It is application's responsibility to +render the strings as well as possible on the user interface. + +
     
    +Exception to these strings are messages sent and received in +Message Payload, which +can include practically any kind of strings with any kind of character +encodings, and binary data also. If UTF-8 encoded message is sent +or received it is indicated with the SILC_MESSAGE_FLAG_UTF8, and +application can render the messages accordingly. + +
     
    +Other strings are always UTF-8 encoded and application needs to decode +the strings to other character encoding if application does not support +UTF-8 rendering on user interface. Also strings application sends to +library, such as, nicknames, channel names, server names, host names, +topic srings, any command argument, etc. must always be UTF-8 encoded +before they are sent to the library. The UTF-8 +routines help the application developer to encode and decode +UTF-8 strings. + +
     
    +The client library does not ever encode or decode strings to or from the +current locale. The library always expects that all strings it receives +from application are already UTF-8 encoded. The library may validate +certain UTF-8 strings and return error if needed. Server may also +send errors in command reply if strings are not encoded properly. + +
     
    +Nicknames and channel names in SILC are also UTF-8 encoded and can +include practically any kind of letters, numbers and punctuation +marks. Control characters and other special characters are not allowed +in nickname strings, and application never receives such nicknames +or channel names from the library. +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclient_using.html b/docs/toolkit/manual/silcclient_using.html new file mode 100644 index 0000000..ee0b387 --- /dev/null +++ b/docs/toolkit/manual/silcclient_using.html @@ -0,0 +1,496 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Using SILC Client Library + +
     
     
    +Introduction + +
     
    +SILC Client library is a full featured SILC Client protocol implementation. +The library has been designed to be complete SILC client without actual +user interface. The library provides the API for the appliation which +it can use to implement generally whatever user interface it wants. The +SILC Client Library recides in the lib/silcclient/ directory. It uses +common and core component of SILC protocol from the lib/silccore, SKE +from lib/silcske and general utility routines from lib/silcutil. + +
     
    +The `silcclient.h' file defines the function prototypes that application +must implement in order to be able to create the user interface with the +library. The idea is that the application can implement whatever user +interface routines in the functions and display the data whatever way +it wants. The library is entirely transparent to the user interface and +it does not include any user interface specific issues such as window +handling or item handling on the screen etc. These does not interest +the library. The `silcclient.h' and `silcclient_entry.h' also defines the +client libary interface the application can call. The interface includes +for example functions for sending channel and private messages, client and +channel retrieval and other utility functions. + +
     
     
    +Including Library Headers + +
     
    +Your application must include the following includes in your sources to +get access all SILC Client Library routines: + +
     
    + +#include "silc.h"
    +#include "silcclient.h" +     + + +
     
     
    +Creating Client + +
     
    +The client is context or entity based, so several client entitites can +be created in the application if needed. However, it should be noted +that they are completely independent from each other and can be seen +as different applications. Usually only one client entity is needed +per application. + +
     
    +The client object is SilcClient which is usually allocated in following +manner: + +
     
    +  SilcClient client = silc_client_alloc(&ops, params, context, NULL); + +
     
    +`ops' is the static structure of client operations that library will call. +`context' can be some application specific context that will be saved into +the SilcClient object. It is up to the caller to free this context. +SilcClient is always passed to the application thus the application +specific context can be retrieved from the SilcClient object. + +
     
    +`ops' can be defined for example as follows: + +
     
    + +SilcClientOperations ops = {
    +   silc_say,
    +   silc_channel_message,
    +   silc_private_message,
    +   silc_notify,
    +   silc_command,
    +   silc_command_reply,
    +   silc_get_auth_method,
    +   silc_verify_public_key,
    +   silc_ask_passphrase,
    +   silc_key_agreement,
    +   silc_file_transfer,
    +};
    +     + +
     
    +Please see the `client_ops_example.c' source file in lib/silcclient/ +directory for predefined structure and stub functions for your +convenience. It is provided for programmers so that they can copy +it and use it directly in their application. + + +
     
     
    +Initializing the Client + +
     
    +The client must be initialized before running. The client is initialized +simply by calling silc_client_init function: + +
     
    +  silc_client_init(client, username, hostname, realname, + foo_client_running, foo_ctx); + +
     
    +which then initializes the client library for the `client'. The `username' +and `hostname' pointers are required. The `foo_client_running' with +`foo_ctx' in this example will be called by the client library after the +client is up and running. After you receive this callback you may start +using other API functions, such as creating connection to remote server. + + +
     
     
    +Running the Client + +
     
    +The client is run by calling silc_client_run. The function will call +the scheduler from utility library that will be run until the program is +ended. When silc_client_run returns the application is ended. Thus, +to run the client, call: + +
     
    +  silc_client_run(client); + +
     
    +Usually application may do some other initializations before calling +this function. For example before calling this function application +should initialize the user interface. + + +
     
     
    +Running the Client in GUI application + +
     
    +Many GUI applications has their own main loop or event loop, which they +would like to use or are forced to use by the underlaying system. If you +are developing for example GUI application on Unix system, and you are +using GTK+ or QT as GUI library you would probably like to use their own +main loop. SILC Client can be run under external main loop as well. The +interface provides a function silc_client_run_one which will run the +client library once, and returns immediately. During that running it can +process incoming data and send outgoing data, but it is guaranteed that it +will not block the calling process. + +
     
    +It is suggested that you would call this function as many times in a +second as possible to provide smooth action for the client library. You +can use an timeout task, or an idle task provided by your GUI library to +accomplish this. After you have initialized the client library with +silc_client_init, you should register the timeout task or idle task that +will call the silc_client_run_one periodically. + +
     
    +For Win32 the silc_client_run can be used instead of using the Windows's +own event loop. However, if you would like to use the silc_client_run_one +also on Win32 system it is possible. + + +
     
     
    +Running Client in GTK-- + +
     
    +Here is a short example how to run the SILC Client libary under the +Gnome/GTK--'s main loop: + +
     
    + +gint YourClass::silc_scheduler()
    +{
    +   // Run the SILC client once, and return immediately. This function
    +   // is called every 50 milliseconds by the Gnome main loop, to process
    +   // SILC stuff. This function will read data, and write data to network,
    +   // etc. Makes the client library tick! :)
    +   silc_client_run_one(silc_client);
    +   return 1;
    +}
    +     + +
     
    +then, during initialization of the SILC Client call: + +
     
    + +// Setup SILC scheduler as timeout task. This will handle the SILC
    +// client library every 50 milliseconds. It will actually make the
    +// SILC client work on background.
    +Gnome::Main::timeout.connect(slot(this, &YourClass::silc_scheduler), 50);
    +     + +
     
    +This will call the function silc_scheduler every 50 millisecconds, which +on the otherhand will call silc_client_run_one, which will make the SILC +Client library work on the background of the GUI application. + + +
     
     
    +Creating Connection to Server + +
     
    +After your client is up and running you may create connection to remote +SILC server. It is done simply by calling: + +
     
    +  silc_client_connect_to_server(client, ¶ms, + public_key, private_key, + remote_host, remote_port, + foo_connected_cb, foo_ctx); + +
     
    +The function will create the connection asynchronously to the server, ie. +the function will return before the actual connection is created. The +`foo_connected_cb' will be called once the connection has been established. +The `params' may be NULL but it may be used to provide additional parameters +to the connecting. For example it is possible to set the initial nickname +you would like to use into the `params'. + + +
     
     
    +Debugging + +
     
    +Being able to debug what you have coded is important when troubles occurs +during coding, and they always do. SILC supports extensive debugging +capabilities which are also available for client library user. You should +have compiled the Toolkit with --enable-debug option so that run-time +debugging is enabled. + +
     
    +Then, to say in your application you would like to use the debugging use +the SILC_DEBUG macro. Put this macro to your main header file, or +some other file that needs the debugging enabled. After using this macro +you are able to use the debugging routines provided by the SILC Toolkit. +Note that, the Toolkit library must be compiled with --enable-debug for +this macro to have any effect. + +
     
    +To turn on the run-time debugging call function silc_log_debug with TRUE +value. To see packet hexdumps you can call also silc_log_debug_hexdump +with TRUE value. Hexdumps can create more debug log so not setting it +to TRUE by default is probably best. To get debug messages out of specific +modules you can set a debug string with silc_log_set_debug_string function. +The function takes regex string as argument, for example: + +
     
    + +  silc_log_debug(TRUE);
    +  silc_log_set_debug_string("*");
    +     + +
     
    +This piece of code turns on the debugging and sets "*" as debug string. This +means that all debug messages are printed. To get debugging out of only +for example SILC Client Library the debug string could be "silc_client*". +The debug string matches to function names and filenames so it is possible +to get debugging out of specific files, and specific functions. Other +examples could be: + +
     
    + +  silc_log_set_debug_string("silc_client*,*sock*,*ske*");
    +     + +
     
    +By default, all debug messages are printed to standard error output (stderr). +If you want to redirect the debug messages somewhere else you can set your +own debug callback with silc_log_set_debug_callbacks function: + +
     
    + +  silc_log_set_debug_callbacks(my_debug_callback, my_context, my_hexdump_callback, my_context);
    +     + +
     
    +See the lib/silcutil/silclog.h for definition of the callbacks. See the +same file for other logging and debugging information. + +
     
    +You can also use SILC debugging capabilities in your own application. To +produce debug messages you can use SILC_LOG_DEBUG and SILC_LOG_HEXDUMP +macros in your application. The SILC_LOG_DEBUG can print out normal debug +messages with variable argument list, for example: + +
     
    + +  SILC_LOG_DEBUG(("Start"));
    +  SILC_LOG_DEBUG(("Packet length %d", packet_len));
    +  SILC_LOG_DEBUG(("The remote is %s on %d", sock->ip, sock->port)); +     + +
     
    +The SILC_LOG_HEXDUMP macro can be used dump data which couldn't be printed +out otherwise, for example binary data. + +
     
    + +  SILC_LOG_HEXDUMP(("Packet"), packet->data, packet->len);
    +  SILC_LOG_HEXDUMP(("Packet, size=%d", size), packet->data, packet->len); +     + +
     
    +Note that the variable arguments in SILC_LOG_HEXDUMP are before the second +last parenthesis, and the last two arguments are the data, and its length that +are hexdumped. +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcclientlib.html b/docs/toolkit/manual/silcclientlib.html new file mode 100644 index 0000000..b270136 --- /dev/null +++ b/docs/toolkit/manual/silcclientlib.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Client Library +
    +Directory: lib/silcclient/ +
    +Library: libsilcclient.a, libsilcclient.lib +

    +Introduction + +

    +SILC Client Library is SILC Client implementation without the actual user +interface. The library uses common and core components of SILC protocol from +lib/silccore library and normal utility routines from lib/silcutil library. +The library has been designed to be complete SILC Client implementation +without actual user interface. The library provides the API for the +application which it can use to implement generally whatever user interface +it wants. + +

    +The `silcclient.h' file defines the function prototypes that application must +implement in order to be able to create the user interface with the +library. The idea is that the application can implement whatever user +interface routines in the functions and display the data whatever way +it wants. The library is entirely transparent to the user interface and +it does not include any user interface specific issues such as window +handling or item handling on the screen etc. These does not interest +the library. + +

    + +
  • Using SILC Client Library Tutorial +
  • Arguments for command_reply Client Operation +
  • SilcStatus Error Arguments in command_reply Client Operation +
  • Arguments for notify Client Operation +
  • Unicode and UTF-8 Strings in Client Library +
  • Client Library Interface Reference +
  • Client Entry Interface Reference +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-SilcCommand.html b/docs/toolkit/manual/silccommand-SilcCommand.html new file mode 100644 index 0000000..437f67e --- /dev/null +++ b/docs/toolkit/manual/silccommand-SilcCommand.html @@ -0,0 +1,274 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcCommand

    + + +NAME + +
    
+    typedef SilcUInt8 SilcCommand;
+
+
    +DESCRIPTION + +
    
+    The SilcCommand type definition and the commands. The commands
+    listed here are the official SILC Commands and they have client
+    and server counterparts.
+
+
    +SOURCE + +
        typedef SilcUInt8 SilcCommand;
+    
+    /* All SILC commands. These are commands that have client and server
+       counterparts. */
+    #define SILC_COMMAND_NONE               0
+    #define SILC_COMMAND_WHOIS              1
+    #define SILC_COMMAND_WHOWAS             2
+    #define SILC_COMMAND_IDENTIFY           3
+    #define SILC_COMMAND_NICK               4
+    #define SILC_COMMAND_LIST               5
+    #define SILC_COMMAND_TOPIC              6
+    #define SILC_COMMAND_INVITE             7
+    #define SILC_COMMAND_QUIT               8
+    #define SILC_COMMAND_KILL               9
+    #define SILC_COMMAND_INFO               10
+    #define SILC_COMMAND_STATS              11
+    #define SILC_COMMAND_PING               12
+    #define SILC_COMMAND_OPER               13
+    #define SILC_COMMAND_JOIN               14
+    #define SILC_COMMAND_MOTD               15
+    #define SILC_COMMAND_UMODE              16
+    #define SILC_COMMAND_CMODE              17
+    #define SILC_COMMAND_CUMODE             18
+    #define SILC_COMMAND_KICK               19
+    #define SILC_COMMAND_BAN                20
+    #define SILC_COMMAND_DETACH             21
+    #define SILC_COMMAND_WATCH              22
+    #define SILC_COMMAND_SILCOPER           23
+    #define SILC_COMMAND_LEAVE              24
+    #define SILC_COMMAND_USERS              25
+    #define SILC_COMMAND_GETKEY             26
+    #define SILC_COMMAND_SERVICE            27
+    
+    /* Private range start */
+    #define SILC_COMMAND_PRIVATE            200
+    #define SILC_COMMAND_PRIV_CONNECT       200
+    #define SILC_COMMAND_PRIV_CLOSE         201
+    #define SILC_COMMAND_PRIV_SHUTDOWN      202
+    
+    /* Reserved */
+    #define SILC_COMMAND_RESERVED           255
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-SilcCommandCb.html b/docs/toolkit/manual/silccommand-SilcCommandCb.html new file mode 100644 index 0000000..e6f6e02 --- /dev/null +++ b/docs/toolkit/manual/silccommand-SilcCommandCb.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcCommandCb

    + + +SYNOPSIS + +
    
+    typedef void (*SilcCommandCb)(void *context, void *context2);
+
+
    +DESCRIPTION + +
    
+    Command function callback. The actual command function pointer.
+    This is generic command callback that the application may choose to
+    use with its command routines.  However, none of the generic
+    routines depend on this callback so application may freely define
+    their own command callback if desired.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-SilcCommandFlags.html b/docs/toolkit/manual/silccommand-SilcCommandFlags.html new file mode 100644 index 0000000..2eefda8 --- /dev/null +++ b/docs/toolkit/manual/silccommand-SilcCommandFlags.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcCommandFlags

    + + +NAME + +
    
+    typedef enum { ... } SilcCommandFlags;
+
+
    +DESCRIPTION + +
    
+    Command flags that set how the commands behave on different
+    situations. These can be OR'es together to set multiple flags.
+    The application is resoponsible of implementing the behaviour
+    of these flags. These are here just to define generic flags.
+    The server usually makes use of these flags.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CF_NONE           = 0,
+    
+      /* Command may only be used once per (about) 2 seconds. Bursts up
+         to 5 commands are allowed though. */
+      SILC_CF_LAG            = (1L << 1),
+    
+      /* Command may only be used once per (about) 2 seconds. No bursts
+         are allowed at all. */
+      SILC_CF_LAG_STRICT     = (1L << 2),
+    
+      /* Command is available for registered connections (connections
+         whose ID has been created. */
+      SILC_CF_REG            = (1L << 3),
+    
+      /* Command is available only for server operators */
+      SILC_CF_OPER           = (1L << 4),
+    
+      /* Command is available only for SILC (router) operators. If this
+         is set SILC_CF_OPER is not necessary to be set. */
+      SILC_CF_SILC_OPER      = (1L << 5),
+    
+    } SilcCommandFlag;
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-SilcCommandPayload.html b/docs/toolkit/manual/silccommand-SilcCommandPayload.html new file mode 100644 index 0000000..571b49f --- /dev/null +++ b/docs/toolkit/manual/silccommand-SilcCommandPayload.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcCommandPayload

    + + +NAME + +
    
+    typedef struct SilcCommandPayloadStruct *SilcCommandPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Command Payload and is allocated
+    by silc_command_payload_parse and given as argument usually to
+    all silc_command_payload_* functions.  It is freed by the
+    silc_command_payload_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_free.html b/docs/toolkit/manual/silccommand-silc_command_free.html new file mode 100644 index 0000000..d39afec --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_free.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_free

    + + +SYNOPSIS + +
    
+    void silc_command_payload_free(SilcCommandPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Command Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_get.html b/docs/toolkit/manual/silccommand-silc_command_get.html new file mode 100644 index 0000000..1e77d7c --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_get.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_get

    + + +SYNOPSIS + +
    
+    SilcCommand silc_command_get(SilcCommandPayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the command from the payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_get_args.html b/docs/toolkit/manual/silccommand-silc_command_get_args.html new file mode 100644 index 0000000..de08ed5 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_get_args.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_get_args

    + + +SYNOPSIS + +
    
+    SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the Arguments Payload containing the arguments from the
+    Command Payload. The caller must not free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_get_ident.html b/docs/toolkit/manual/silccommand-silc_command_get_ident.html new file mode 100644 index 0000000..75715f2 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_get_ident.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_get_ident

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_command_get_ident(SilcCommandPayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the command identifier from the payload. The identifier can
+    be used to identify which command reply belongs to which command.
+    The client sets the identifier to the payload and server must return
+    the same identifier in the command reply.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_get_status.html b/docs/toolkit/manual/silccommand-silc_command_get_status.html new file mode 100644 index 0000000..d61e5b4 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_get_status.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_get_status

    + + +SYNOPSIS + +
    
+    SilcBool silc_command_get_status(SilcCommandPayload payload,
+                                 SilcStatus *status,
+                                 SilcStatus *error);
+
+
    +DESCRIPTION + +
    
+    This function returns the command reply status into `status' and
+    error status, if error occurred into the `error'.  The function
+    returns TRUE if command reply status is not error, and FALSE if
+    error occurred.  In this case the `error' will include the actual
+    error status.  The `status' can be in this case some list value
+    which indicates that there will be list of errors.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_payload_encode.html b/docs/toolkit/manual/silccommand-silc_command_payload_encode.html new file mode 100644 index 0000000..cd13f5e --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_payload_encode.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_command_payload_encode(SilcCommand cmd,
+                                           SilcUInt32 argc,
+                                           unsigned char **argv,
+                                           SilcUInt32 *argv_lens,
+                                           SilcUInt32 *argv_types,
+                                           SilcUInt16 ident);
+
+
    +DESCRIPTION + +
    
+     Encodes Command Payload returning it to SilcBuffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_payload_encode_payload.html b/docs/toolkit/manual/silccommand-silc_command_payload_encode_payload.html new file mode 100644 index 0000000..ecffe86 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_payload_encode_payload.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_payload_encode_payload

    + + +SYNOPSIS + +
    
+    SilcBuffer
+    silc_command_payload_encode_payload(SilcCommandPayload payload);
+
+
    +DESCRIPTION + +
    
+    Same as silc_command_payload_encode but encodes the buffer from
+    SilcCommandPayload structure instead of raw data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_payload_encode_va.html b/docs/toolkit/manual/silccommand-silc_command_payload_encode_va.html new file mode 100644 index 0000000..b16d21f --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_payload_encode_va.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_payload_encode_va

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
+                                              SilcUInt16 ident,
+                                              SilcUInt32 argc, ...);
+
+
    +DESCRIPTION + +
    
+    Encodes Command payload with variable argument list. The arguments
+    must be: SilcUInt32, unsigned char *, unsigned int, ... One
+    {SilcUInt32, unsigned char * and unsigned int} forms one argument,
+    thus `argc' in case when sending one {SilcUInt32, unsigned char *
+    and SilcUInt32} equals one (1) and when sending two of those it
+    equals two (2), and so on. This has to be preserved or bad things
+    will happen. The variable arguments is: {type, data, data_len}.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_payload_encode_vap.html b/docs/toolkit/manual/silccommand-silc_command_payload_encode_vap.html new file mode 100644 index 0000000..bfb5a12 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_payload_encode_vap.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_payload_encode_vap

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
+                                               SilcUInt16 ident,
+                                               SilcUInt32 argc, va_list ap);
+
+
    +DESCRIPTION + +
    
+    This is equivalent to the silc_command_payload_encode_va except
+    takes the va_list as argument.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_payload_parse.html b/docs/toolkit/manual/silccommand-silc_command_payload_parse.html new file mode 100644 index 0000000..d98be58 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_payload_parse.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_payload_parse

    + + +SYNOPSIS + +
    
+    SilcCommandPayload
+    silc_command_payload_parse(const unsigned char *payload,
+                               SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parses command payload returning new command payload structure. The
+    `buffer' is the raw payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_va.html b/docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_va.html new file mode 100644 index 0000000..e0617fd --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_va.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_reply_payload_encode_va

    + + +SYNOPSIS + +
    
+    SilcBuffer
+    silc_command_reply_payload_encode_va(SilcCommand cmd,
+                                         SilcStatus status,
+                                         SilcStatus error,
+                                         SilcUInt16 ident,
+                                         SilcUInt32 argc, ...);
+
+
    +DESCRIPTION + +
    
+    Same as silc_command_payload_encode_va except that this is used to
+    encode strictly command reply packets.  The `argc' must not count
+    `status' and `error' as arguments.  The `status' includes the
+    command reply status.  If single reply will be sent then it includes
+    SILC_STATUS_OK if error did not occur.  It includes an error value
+    if error did occur.  In this case `error' field is ignored.  If
+    there will be multiple successful command replies then the `status'
+    includes a list value and `error' is ignored.  If there will
+    multiple error replies the `status' includes a list value, and
+    the `error' includes an error value.  Thus, the `error' value is
+    specified only if there will be list of errors.
+
+
    +NOTES + +
    
+    Protocol defines that it is possible to send both list of successful
+    and list of error replies at the same time, as long as the error
+    replies are sent after the successful replies.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_vap.html b/docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_vap.html new file mode 100644 index 0000000..c016d52 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_reply_payload_encode_vap.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_reply_payload_encode_vap

    + + +SYNOPSIS + +
    
+    SilcBuffer
+    silc_command_reply_payload_encode_vap(SilcCommand cmd,
+                                          SilcStatus status,
+                                          SilcStatus error,
+                                          SilcUInt16 ident, SilcUInt32 argc,
+                                          va_list ap);
+
+
    +DESCRIPTION + +
    
+    This is equivalent to the silc_command_reply_payload_encode_va except
+    takes the va_list as argument.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_set_command.html b/docs/toolkit/manual/silccommand-silc_command_set_command.html new file mode 100644 index 0000000..419298d --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_set_command.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_set_command

    + + +SYNOPSIS + +
    
+    void silc_command_set_command(SilcCommandPayload payload,
+                                  SilcCommand command);
+
+
    +DESCRIPTION + +
    
+    Function to set the command to already allocated Command Payload. This
+    makes it easy to change the command in the payload without encoding new
+    Command Payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand-silc_command_set_ident.html b/docs/toolkit/manual/silccommand-silc_command_set_ident.html new file mode 100644 index 0000000..cb619c3 --- /dev/null +++ b/docs/toolkit/manual/silccommand-silc_command_set_ident.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_command_set_ident

    + + +SYNOPSIS + +
    
+    void silc_command_set_ident(SilcCommandPayload payload,
+                                SilcUInt16 ident);
+
+
    +DESCRIPTION + +
    
+    Function to set identifier to already allocated Command Payload. Command
+    payloads are frequentlly resent in SILC and thusly this makes it easy
+    to set the identifier without encoding new Command Payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Command Interface
    +SilcCommandCb
    +SilcCommandPayload
    +SilcCommandFlags
    +SilcCommand
    +silc_command_payload_parse
    +silc_command_payload_encode
    +silc_command_payload_encode_payload
    +silc_command_payload_encode_va
    +silc_command_payload_encode_vap
    +silc_command_reply_payload_encode_va
    +silc_command_reply_payload_encode_vap
    +silc_command_free
    +silc_command_get
    +silc_command_get_args
    +silc_command_get_ident
    +silc_command_get_status
    +silc_command_set_ident
    +silc_command_set_command
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand.html b/docs/toolkit/manual/silccommand.html new file mode 100644 index 0000000..4bf2954 --- /dev/null +++ b/docs/toolkit/manual/silccommand.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silccommand.html + + + + +
    + +SILC Command Interface
    Header: silccommand.h

    + + +DESCRIPTION + +
    
+ Implementation of the Command Payload. The Command Payload is used to
+ send commands and also command replies usually between client and
+ server.
+
+
  • SilcCommandCb +
  • SilcCommandPayload +
  • SilcCommandFlags +
  • SilcCommand +
  • silc_command_payload_parse +
  • silc_command_payload_encode +
  • silc_command_payload_encode_payload +
  • silc_command_payload_encode_va +
  • silc_command_payload_encode_vap +
  • silc_command_reply_payload_encode_va +
  • silc_command_reply_payload_encode_vap +
  • silc_command_free +
  • silc_command_get +
  • silc_command_get_args +
  • silc_command_get_ident +
  • silc_command_get_status +
  • silc_command_set_ident +
  • silc_command_set_command + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccommand.xref b/docs/toolkit/manual/silccommand.xref new file mode 100644 index 0000000..1470719 --- /dev/null +++ b/docs/toolkit/manual/silccommand.xref @@ -0,0 +1,25 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silccommand.h" "/home/priikone/silc1/doc/toolkit/silccommand.html" 0 + "SILC Command Interface" "/home/priikone/silc1/doc/toolkit/silccommand.html" 1 + "SilcCommandCb" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "SilcCommandPayload" "/home/priikone/silc1/doc/toolkit/silccommand.html" 5 + "SilcCommandFlags" "/home/priikone/silc1/doc/toolkit/silccommand.html" 8 + "SilcCommand" "/home/priikone/silc1/doc/toolkit/silccommand.html" 8 + "silc_command_payload_parse" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_payload_encode" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_payload_encode_payload" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_payload_encode_va" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_payload_encode_vap" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_reply_payload_encode_va" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_reply_payload_encode_vap" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_free" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_get" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_get_args" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_get_ident" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_get_status" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_set_ident" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + "silc_command_set_command" "/home/priikone/silc1/doc/toolkit/silccommand.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silccond-SilcCond.html b/docs/toolkit/manual/silccond-SilcCond.html new file mode 100644 index 0000000..8a60fe5 --- /dev/null +++ b/docs/toolkit/manual/silccond-SilcCond.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcCond

    + + +NAME + +
    
+    typedef struct SilcCondStruct *SilcCond;
+
+
    +DESCRIPTION + +
    
+    This context is the actual condition variable and is allocated
+    by silc_cond_alloc and given as argument to all silc_cond_*
+    functions.  It is freed by the silc_cond_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Condition Variable Interface
    +SilcCond
    +silc_cond_alloc
    +silc_cond_free
    +silc_cond_wait
    +silc_cond_timedwait
    +silc_cond_signal
    +silc_cond_broadcast
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond-silc_cond_alloc.html b/docs/toolkit/manual/silccond-silc_cond_alloc.html new file mode 100644 index 0000000..fa242d2 --- /dev/null +++ b/docs/toolkit/manual/silccond-silc_cond_alloc.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure silc_cond_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_cond_alloc(SilcCond *cond);
+
+
    +DESCRIPTION + +
    
+    Allocates SILC Condition variable context.  The condition must
+    be allocated before it can be used.  It is freed by the
+    silc_cond_free function.  This returns TRUE and allocated
+    condition in to the `cond' pointer and FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Condition Variable Interface
    +SilcCond
    +silc_cond_alloc
    +silc_cond_free
    +silc_cond_wait
    +silc_cond_timedwait
    +silc_cond_signal
    +silc_cond_broadcast
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond-silc_cond_broadcast.html b/docs/toolkit/manual/silccond-silc_cond_broadcast.html new file mode 100644 index 0000000..400195a --- /dev/null +++ b/docs/toolkit/manual/silccond-silc_cond_broadcast.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure silc_cond_broadcast

    + + +SYNOPSIS + +
    
+    void silc_cond_broadcast(SilcCond cond);
+
+
    +DESCRIPTION + +
    
+    Signals and wakes up all waiters.  If there are no waiters this
+    function has no effect.
+
+
    +NOTES + +
    
+    Before calling this function the mutex used with the silc_cond_wait
+    must be acquired.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Condition Variable Interface
    +SilcCond
    +silc_cond_alloc
    +silc_cond_free
    +silc_cond_wait
    +silc_cond_timedwait
    +silc_cond_signal
    +silc_cond_broadcast
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond-silc_cond_free.html b/docs/toolkit/manual/silccond-silc_cond_free.html new file mode 100644 index 0000000..5c473a9 --- /dev/null +++ b/docs/toolkit/manual/silccond-silc_cond_free.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure silc_cond_free

    + + +SYNOPSIS + +
    
+    void silc_cond_free(SilcCond cond);
+
+
    +DESCRIPTION + +
    
+    Free condition variable context.  If `cond' is NULL this function
+    has no effect.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Condition Variable Interface
    +SilcCond
    +silc_cond_alloc
    +silc_cond_free
    +silc_cond_wait
    +silc_cond_timedwait
    +silc_cond_signal
    +silc_cond_broadcast
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond-silc_cond_signal.html b/docs/toolkit/manual/silccond-silc_cond_signal.html new file mode 100644 index 0000000..d805ff8 --- /dev/null +++ b/docs/toolkit/manual/silccond-silc_cond_signal.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure silc_cond_signal

    + + +SYNOPSIS + +
    
+    void silc_cond_signal(SilcCond cond);
+
+
    +DESCRIPTION + +
    
+    Signals a waiting thread and wakes it up.  If there are no waiters
+    this function has no effect.  In case of multiple waiters only one
+    is signalled.  To signal all of them use silc_cond_broadcast.
+
+
    +NOTES + +
    
+    Before calling this function the mutex used with the silc_cond_wait
+    must be acquired.
+
+
    +EXAMPLE + +
    
+    silc_mutex_lock(lock);
+    c->a = context;
+    silc_cond_signal(cond);
+    silc_mutex_unlock(lock);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Condition Variable Interface
    +SilcCond
    +silc_cond_alloc
    +silc_cond_free
    +silc_cond_wait
    +silc_cond_timedwait
    +silc_cond_signal
    +silc_cond_broadcast
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond-silc_cond_timedwait.html b/docs/toolkit/manual/silccond-silc_cond_timedwait.html new file mode 100644 index 0000000..c9a47bf --- /dev/null +++ b/docs/toolkit/manual/silccond-silc_cond_timedwait.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure silc_cond_timedwait

    + + +SYNOPSIS + +
    
+    void silc_cond_timedwait(SilcCond cond, SilcMutex mutex, int timeout);
+
+
    +DESCRIPTION + +
    
+    Waits for condition variable `cond' to be signalled or for the
+    `timeout' to expire.  The timeout is in milliseconds.  If it is 0
+    no timeout exist.  Returns FALSE if timeout expired, TRUE when
+    signalled.  This function will block the calling thread until the
+    condition variable is signalled.  The `mutex' must be locked before
+    calling this function.  The `mutex' will be unlocked inside this
+    function.  After this function returns the `mutex' is in locked
+    state again.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Condition Variable Interface
    +SilcCond
    +silc_cond_alloc
    +silc_cond_free
    +silc_cond_wait
    +silc_cond_timedwait
    +silc_cond_signal
    +silc_cond_broadcast
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond-silc_cond_wait.html b/docs/toolkit/manual/silccond-silc_cond_wait.html new file mode 100644 index 0000000..109d4b4 --- /dev/null +++ b/docs/toolkit/manual/silccond-silc_cond_wait.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure silc_cond_wait

    + + +SYNOPSIS + +
    
+    void silc_cond_wait(SilcCond cond, SilcMutex mutex);
+
+
    +DESCRIPTION + +
    
+    Waits for condition variable `cond' to be signalled.  This function
+    will block the calling thread until the condition variable is
+    signalled.  The `mutex' must be locked before calling this function.
+    The `mutex' will be unlocked inside this function.  After this
+    function returns the `mutex' is in locked state again.
+
+
    +EXAMPLE + +
    
+    silc_mutex_lock(lock);
+    while (c->a == NULL)
+      silc_cond_wait(cond, lock);
+    ...
+    silc_mutex_unlock(lock);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Condition Variable Interface
    +SilcCond
    +silc_cond_alloc
    +silc_cond_free
    +silc_cond_wait
    +silc_cond_timedwait
    +silc_cond_signal
    +silc_cond_broadcast
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond.html b/docs/toolkit/manual/silccond.html new file mode 100644 index 0000000..805452f --- /dev/null +++ b/docs/toolkit/manual/silccond.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silccond.html + + + + +
    + +SILC Condition Variable Interface
    Header: silccond.h

    + + +DESCRIPTION + +
    
+ A condition variable interface for multi-thread synchronization.
+ Condition variables enable threads to suspend execution and yield
+ the processors until some predicate on some shared data is satisfied.
+
+
  • SilcCond +
  • silc_cond_alloc +
  • silc_cond_free +
  • silc_cond_wait +
  • silc_cond_timedwait +
  • silc_cond_signal +
  • silc_cond_broadcast + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccond.xref b/docs/toolkit/manual/silccond.xref new file mode 100644 index 0000000..d43d319 --- /dev/null +++ b/docs/toolkit/manual/silccond.xref @@ -0,0 +1,14 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silccond.h" "/home/priikone/silc1/doc/toolkit/silccond.html" 0 + "SILC Condition Variable Interface" "/home/priikone/silc1/doc/toolkit/silccond.html" 1 + "SilcCond" "/home/priikone/silc1/doc/toolkit/silccond.html" 5 + "silc_cond_alloc" "/home/priikone/silc1/doc/toolkit/silccond.html" 5 + "silc_cond_free" "/home/priikone/silc1/doc/toolkit/silccond.html" 5 + "silc_cond_wait" "/home/priikone/silc1/doc/toolkit/silccond.html" 5 + "silc_cond_timedwait" "/home/priikone/silc1/doc/toolkit/silccond.html" 5 + "silc_cond_signal" "/home/priikone/silc1/doc/toolkit/silccond.html" 5 + "silc_cond_broadcast" "/home/priikone/silc1/doc/toolkit/silccond.html" 5 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcconfig-SILC_CONFIG_CALLBACK.html b/docs/toolkit/manual/silcconfig-SILC_CONFIG_CALLBACK.html new file mode 100644 index 0000000..abbea27 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-SILC_CONFIG_CALLBACK.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_CONFIG_CALLBACK

    + + +NAME + +
    
+    #define SILC_CONFIG_CALLBACK ...
+
+
    +DESCRIPTION + +
    
+    Generic macro to define SilcConfigCallback functions. This defines a
+    static function with name `func' as a config callback function.
+
+
    +SOURCE + +
        #define SILC_CONFIG_CALLBACK(func)                              \
+    static int func(SilcConfigType type, const char *name,          \
+                    SilcUInt32 line, void *val, void *context)
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-SilcConfigCallback.html b/docs/toolkit/manual/silcconfig-SilcConfigCallback.html new file mode 100644 index 0000000..1d57ecf --- /dev/null +++ b/docs/toolkit/manual/silcconfig-SilcConfigCallback.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcConfigCallback

    + + +SYNOPSIS + +
    
+    typedef int (*SilcConfigCallback)(SilcConfigType type, const char *name,
+                                      SilcUInt32 line, void *val,
+                                      void *context);
+
    +DESCRIPTION + +
    
+    This is the callback prototype for the options handler.  The pointer
+    `val' points to a location of type described by `type'.  `name' points
+    to a null-terminated string with the name of the option which triggered
+    this callback, that is stated at line `line'.  `context' is the
+    user-specified context provided when this option was registered.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-SilcConfigEntity.html b/docs/toolkit/manual/silcconfig-SilcConfigEntity.html new file mode 100644 index 0000000..3a5d145 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-SilcConfigEntity.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcConfigEntity

    + + +SYNOPSIS + +
    
+    typedef struct SilcConfigEntityObject *SilcConfigEntity;
+
+
    +DESCRIPTION + +
    
+    The SILC Config is based on config entities.  An entity contains the
+    SilcConfigFile object we are parsing and the registered options.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-SilcConfigErrno.html b/docs/toolkit/manual/silcconfig-SilcConfigErrno.html new file mode 100644 index 0000000..8dfb32a --- /dev/null +++ b/docs/toolkit/manual/silcconfig-SilcConfigErrno.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcConfigErrno

    + + +NAME + +
    
+    enum { ... } - describe a SILC Config error
+
+
    +DESCRIPTION + +
    
+    The virtual integer `errno' is returned by the silc_config_main()
+    function and indicates what went wrong.
+    You can convert it to the corresponding error string with the function
+    silc_config_strerror().
+
+
    +SOURCE + +
        enum {
+      SILC_CONFIG_OK,               /* OK */
+      SILC_CONFIG_ESILENT,          /* Error defined by callback function */
+      SILC_CONFIG_EPRINTLINE,       /* Error defined by callback function */
+      SILC_CONFIG_EGENERIC,         /* Invalid syntax */
+      SILC_CONFIG_EINTERNAL,        /* Internal Error (caused by developer) */
+      SILC_CONFIG_ECANTOPEN,        /* Can't open specified file */
+      SILC_CONFIG_EOPENBRACE,       /* Expected open-brace '{' */
+      SILC_CONFIG_ECLOSEBRACE,      /* Missing close-brace '}' */
+      SILC_CONFIG_ETYPE,            /* Invalid data type */
+      SILC_CONFIG_EBADOPTION,       /* Unknown option */
+      SILC_CONFIG_EINVALIDTEXT,     /* Invalid text */
+      SILC_CONFIG_EDOUBLE,          /* Double option specification */
+      SILC_CONFIG_EEXPECTED,        /* Expected data but not found */
+      SILC_CONFIG_EEXPECTEDEQUAL,   /* Expected '=' */
+      SILC_CONFIG_EUNEXPECTED,      /* Unexpected data */
+      SILC_CONFIG_EMISSFIELDS,      /* Missing mandatory fields */
+      SILC_CONFIG_EMISSCOLON,       /* Missing ';' */
+    };
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-SilcConfigFile.html b/docs/toolkit/manual/silcconfig-SilcConfigFile.html new file mode 100644 index 0000000..53e26ad --- /dev/null +++ b/docs/toolkit/manual/silcconfig-SilcConfigFile.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcConfigFile

    + + +SYNOPSIS + +
    
+    typedef struct SilcConfigFileObject SilcConfigFile;
+
+
    +DESCRIPTION + +
    
+    A File object holds the data contained in a previously loaded file by
+    the silc_config_open() function.
+    This is an internally allocated struct and must be used only with the
+    helper functions.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-SilcConfigTable.html b/docs/toolkit/manual/silcconfig-SilcConfigTable.html new file mode 100644 index 0000000..46e47fa --- /dev/null +++ b/docs/toolkit/manual/silcconfig-SilcConfigTable.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcConfigTable

    + + +SYNOPSIS + +
    
+    typedef struct { ... } SilcConfigTable;
+
+
    +DESCRIPTION + +
    
+    SILC Config table defines an easy and quick way of registering options
+    in an entity. The function silc_config_register_table() will take as
+    argument a SilcConfigTable array terminated by a NULL struct, it is
+    important thus, that the `name' field of the terminating struct is set
+    to NULL.
+
+    char *name
+
+       The option name lowercase. The matching is always case-insensitive,
+       but for convention the option specification must always be lowercase.
+
+    SilcConfigType type
+
+       This specifies what kind of parameter this option expects.  The
+       special cases SILC_CONFIG_ARG_BLOCK tells SILC Config that this is
+       not a normal option but the name of a sub-block of the current
+       block (there is no limit to the number of nested blocks allowed).
+
+    SilcConfigCallback callback
+
+       Normally this is the value handler of the current option. If this
+       field is set to NULL then the value is silently discarded. Useful
+       for example to support deprecated options.
+
+    SilcConfigTable *subtable
+
+       If the `type' field is set to SILC_CONFIG_ARG_BLOCK, then this field
+       must point to a valid sub-table NULL-terminated array. If `type' is
+       something else, this valued is unused.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-SilcConfigType.html b/docs/toolkit/manual/silcconfig-SilcConfigType.html new file mode 100644 index 0000000..f93cb33 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-SilcConfigType.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcConfigType

    + + +NAME + +
    
+    typedef enum { ... } SilcConfigType;
+
+
    +DESCRIPTION + +
    
+    This identifies the parameter type that an option has. This parameter
+    is very important because the callback's *val pointer points to a
+    memory location containing the previously specified data type.
+    For example, if you specified an option with an integer parameter
+    callback's *val will be a pointer to an integer.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CONFIG_ARG_TOGGLE,       /* TOGGLE on,off; yes,no; true, false; */
+      SILC_CONFIG_ARG_INT,          /* callback wants an integer */
+      SILC_CONFIG_ARG_STR,          /* callback expects \0-terminated str */
+      SILC_CONFIG_ARG_STRE,         /* same as above, but can also be empty */
+      SILC_CONFIG_ARG_BLOCK,        /* this is a sub-block */
+      SILC_CONFIG_ARG_SIZE,         /* like int, but accepts suffixes kMG */
+      SILC_CONFIG_ARG_NONE,         /* does not expect any args */
+    } SilcConfigType;
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_close.html b/docs/toolkit/manual/silcconfig-silc_config_close.html new file mode 100644 index 0000000..617b6cc --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_close.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_close

    + + +SYNOPSIS + +
    
+    void silc_config_close(SilcConfigFile *file);
+
+
    +DESCRIPTION + +
    
+    Closes and frees the File object `file', which must have been returned
+    by a previous call to silc_config_open().  Otherwise, or if
+    this function has already been called before for the same File object,
+    undefined behaviour occurs.
+    If `file' is NULL, no operation is performed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_get_filename.html b/docs/toolkit/manual/silcconfig-silc_config_get_filename.html new file mode 100644 index 0000000..016f4c4 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_get_filename.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_get_filename

    + + +SYNOPSIS + +
    
+    char *silc_config_get_filename(SilcConfigFile *file);
+
+
    +DESCRIPTION + +
    
+    Returns the original filename of the object file.
+    The returned pointer points to internally allocated storage and must
+    not be freed, modified or stored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_get_line.html b/docs/toolkit/manual/silcconfig-silc_config_get_line.html new file mode 100644 index 0000000..f3b8e03 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_get_line.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_get_line

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_config_get_line(SilcConfigFile *file);
+
+
    +DESCRIPTION + +
    
+    Returns the current line that file parsing arrived at.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_init.html b/docs/toolkit/manual/silcconfig-silc_config_init.html new file mode 100644 index 0000000..f7399db --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_init.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_init

    + + +SYNOPSIS + +
    
+    SilcConfigEntity silc_config_init(SilcConfigFile *file);
+
+
    +DESCRIPTION + +
    
+    Creates an Entity pointing to the valid File object `file', which must
+    be returned by a previous call to silc_config_open(), otherwise NULL
+    is returned.
+    Entities will be automatically destroyed after the call to the
+    silc_config_main() function, because of this no uninit functions are
+    provided.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_main.html b/docs/toolkit/manual/silcconfig-silc_config_main.html new file mode 100644 index 0000000..fdddc50 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_main.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_main

    + + +SYNOPSIS + +
    
+    int silc_config_main(SilcConfigEntity ent);
+
+
    +DESCRIPTION + +
    
+    Enter the main parsing loop. When this function returns the parsing
+    is finished in the current block (and sub-blocks).
+
+    When this function exits, the entity is already destroyed, because
+    of this you should set it to NULL right after the function call.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_open.html b/docs/toolkit/manual/silcconfig-silc_config_open.html new file mode 100644 index 0000000..c6db0b5 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_open.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_open

    + + +SYNOPSIS + +
    
+    SilcConfigFile *silc_config_open(char *configfile);
+
+
    +DESCRIPTION + +
    
+    Tries to open the config file `configfile' and returns a valid File
+    object on success, or NULL on failure.
+    An File object created this way must be destroyed with the function
+    silc_config_close().
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_read_current_line.html b/docs/toolkit/manual/silcconfig-silc_config_read_current_line.html new file mode 100644 index 0000000..c958018 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_read_current_line.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_read_current_line

    + + +SYNOPSIS + +
    
+    char *silc_config_read_current_line(SilcConfigFile *file);
+
+
    +DESCRIPTION + +
    
+    Returns a dynamically allocated buffer containing the line that the
+    parser stopped at.  This is a convenience function for
+    silc_config_read_line.
+    The returned pointer must be freed when it's not needed any longer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_read_line.html b/docs/toolkit/manual/silcconfig-silc_config_read_line.html new file mode 100644 index 0000000..015c57b --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_read_line.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_read_line

    + + +SYNOPSIS + +
    
+    char *silc_config_read_line(SilcConfigFile *file, SilcUInt32 line);
+
+
    +DESCRIPTION + +
    
+    Returns a dynamically allocated null-terminated buffer containing the
+    line `line' of `file'.
+    The returned pointer must be freed when it's not needed any longer.
+
+
    +SEE ALSO + +
        silc_config_read_current_line
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_register.html b/docs/toolkit/manual/silcconfig-silc_config_register.html new file mode 100644 index 0000000..cf37d9a --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_register.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_register

    + + +SYNOPSIS + +
    
+    SilcBool silc_config_register(SilcConfigEntity ent, const char *name,
+                              SilcConfigType type, SilcConfigCallback cb,
+                              const SilcConfigTable *subtable,
+                              void *context);
+
+
    +DESCRIPTION + +
    
+    Register option `name' in the entity `ent'. If `cb' is not NULL, it
+    will be called with the *val pointer pointing to an internally
+    allocated storage of type described by `type'.
+
+    If `type' is SILC_CONFIG_ARG_BLOCK, then `subtable' must be a valid
+    pointer to a SilcConfigTable array specifying the options in the
+    sub-block.
+
+    If the option `name' was already registered in this sub-block or it
+    matches the reserved word "Include", then this function returns FALSE,
+    otherwise it returns TRUE.
+
+
    +SEE ALSO + +
        silc_config_register_table
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_register_table.html b/docs/toolkit/manual/silcconfig-silc_config_register_table.html new file mode 100644 index 0000000..a28fcba --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_register_table.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_register_table

    + + +SYNOPSIS + +
    
+    SilcBool silc_config_register_table(SilcConfigEntity ent,
+                                    const SilcConfigTable table[],
+                                    void *context);
+
+
    +DESCRIPTION + +
    
+    Register the tableset of options `table' automatically in the entity
+    `ent'.  If defined in the table, the callback functions will be called
+    all with the same context `context'.
+
+    The `table' array must be terminated with an entry with the name field
+    set to NULL.
+
+    If the table contains invalid data this function returns FALSE, otherwise
+    it returns TRUE.  If a calling to this function failed, you must destroy
+    and recreate the entity before retrying, as it's impossible to detect
+    the point at the function stopped the registering process.
+
+
    +SEE ALSO + +
        SilcConfigTable
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig-silc_config_strerror.html b/docs/toolkit/manual/silcconfig-silc_config_strerror.html new file mode 100644 index 0000000..9eaa702 --- /dev/null +++ b/docs/toolkit/manual/silcconfig-silc_config_strerror.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_config_strerror

    + + +SYNOPSIS + +
    
+    char *silc_config_strerror(int errnum);
+
+
    +DESCRIPTION + +
    
+    The silc_config_strerror() function returns a string describing the
+    error code passed in the argument `errnum'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Config Interface
    +SilcConfigErrno
    +SilcConfigType
    +SilcConfigCallback
    +SilcConfigTable
    +SilcConfigFile
    +SilcConfigEntity
    +SILC_CONFIG_CALLBACK
    +silc_config_open
    +silc_config_close
    +silc_config_init
    +silc_config_strerror
    +silc_config_get_filename
    +silc_config_get_line
    +silc_config_read_line
    +silc_config_read_current_line
    +silc_config_register
    +silc_config_register_table
    +silc_config_main
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig.html b/docs/toolkit/manual/silcconfig.html new file mode 100644 index 0000000..931dca4 --- /dev/null +++ b/docs/toolkit/manual/silcconfig.html @@ -0,0 +1,277 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcconfig.html + + + + +
    + +SILC Config Interface
    Header: silcconfig.h

    + + +DESCRIPTION + +
    
+ The SILC Config util library is based on two main objects, SilcConfigFile
+ (or File object) and SilcConfigEntity (or Entity).  The File objects are
+ structs directly corresponding to the real files in the filesystem, while
+ Entities are a little more abstract.
+
+ An Entity is composed by delimited area on a File object (it can take the
+ whole File object or just part of it), plus a group of known options.
+ In order to parse this file, first you need to create a File object with
+ the silc_config_open() function, and then you need to create the Entity
+ with the silc_config_init() function.
+
+ Now you can use the newly created Entity to register a group of expected
+ known options and sub-blocks, and then you can call the main parsing loop
+ with the silc_config_main() function. When silc_config_main() will 
+ return, if some error encoured the object file will point to the file 
+ that caused this error (this can be different from the originally 
+ opened file if it contained `Include' directives).  If no errors 
+ encoured then the File objects will still point to the original file.
+
+ While silc_config_main() will take care of destroying Entities before
+ returning, you need to take care that the File object you created is freed
+ with the silc_config_close() function.
+
+ The SILC Config library won't take care about storing the values contained
+ in the config file.  You must take care about it with the callback
+ functions.
+
+ The config file syntax is pretty straightforward.  All lines starting
+ with `#' will be skipped, while sub-blocks are delimited by braces (see
+ the example below).
+
+ Options with argument must have the `=' character between the option
+ name and the value.  Simple words and numbers does not require quoting.
+ There is a special built-in directive "Include" which allows you to include
+ another config file in the point the directive is.  You can also Include
+ inside a sub-block body, in this case when parsing the included config file
+ it will be assumed that we are within this block, and the included file
+ won't be allowed to close his root block.
+
+ Example:
+
+    cipher {
+       name = aes-256-cbc;
+       module = "aes.sim.so";
+       key_length = 32;       # usually the default is just fine
+       block_length = 16;
+    };
+    Include "/etc/silc/hash_funcs.conf";
+
+
  • SilcConfigErrno +
  • SilcConfigType +
  • SilcConfigCallback +
  • SilcConfigTable +
  • SilcConfigFile +
  • SilcConfigEntity +
  • SILC_CONFIG_CALLBACK +
  • silc_config_open +
  • silc_config_close +
  • silc_config_init +
  • silc_config_strerror +
  • silc_config_get_filename +
  • silc_config_get_line +
  • silc_config_read_line +
  • silc_config_read_current_line +
  • silc_config_register +
  • silc_config_register_table +
  • silc_config_main + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconfig.xref b/docs/toolkit/manual/silcconfig.xref new file mode 100644 index 0000000..6960ab6 --- /dev/null +++ b/docs/toolkit/manual/silcconfig.xref @@ -0,0 +1,25 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcconfig.h" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 0 + "SILC Config Interface" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 1 + "SilcConfigErrno" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 8 + "SilcConfigType" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 8 + "SilcConfigCallback" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "SilcConfigTable" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 5 + "SilcConfigFile" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 5 + "SilcConfigEntity" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 5 + "SILC_CONFIG_CALLBACK" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 8 + "silc_config_open" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_close" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_init" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_strerror" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_get_filename" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_get_line" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_read_line" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_read_current_line" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_register" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_register_table" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + "silc_config_main" "/home/priikone/silc1/doc/toolkit/silcconfig.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcconnauth-SilcConnAuth.html b/docs/toolkit/manual/silcconnauth-SilcConnAuth.html new file mode 100644 index 0000000..8ed6a98 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-SilcConnAuth.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcConnAuth

    + + +NAME + +
    
+    typedef struct SilcConnAuthStruct *SilcConnAuth;
+
+
    +DESCRIPTION + +
    
+    The connection authentication context allocated by silc_connauth_alloc
+    and given as arguments to all silc_connauth_* functions.  It is freed
+    by silc_connauth_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-SilcConnAuthCompletion.html b/docs/toolkit/manual/silcconnauth-SilcConnAuthCompletion.html new file mode 100644 index 0000000..534c139 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-SilcConnAuthCompletion.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcConnAuthCompletion

    + + +SYNOPSIS + +
    
+    typedef void (*SilcConnAuthCompletion)(SilcConnAuth connauth,
+                                           SilcBool success,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    Completion callback called to indicated the result of the connection
+    authentication protocol.  If the `success' is FALSE the authentication
+    was a failure.  The authentication protocol is over after this callback
+    is called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-SilcConnAuthGetAuthData.html b/docs/toolkit/manual/silcconnauth-SilcConnAuthGetAuthData.html new file mode 100644 index 0000000..9449761 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-SilcConnAuthGetAuthData.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcConnAuthGetAuthData

    + + +SYNOPSIS + +
    
+    typedef SilcBool
+    (*SilcConnAuthGetAuthData)(SilcConnAuth connauth,
+                               SilcConnectionType conn_type,
+                               unsigned char **passphrase,
+                               SilcUInt32 *passphrase_len,
+                               SilcSKR *repository,
+                               void *context);
+
+
    +DESCRIPTION + +
    
+    Authentication callback to retrieve the authentication data from the
+    application.  This is responder callback.  If the authentication
+    method is passphrase it must be returned to `passphrase' pointer.
+    If it is digital signatures the key repository pointer must be
+    returned into `repository' pointer, which the library will use to
+    find the correct public key to verify the digital signature.  If
+    neither `passphrase' or `repository' is set but TRUE is returned,
+    authentication is not required.
+
+    If this connection is not configured at all this returns FALSE which
+    will result into authentication failure.  Otherwise TRUE must be
+    returned.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-SilcConnectionType.html b/docs/toolkit/manual/silcconnauth-SilcConnectionType.html new file mode 100644 index 0000000..982f768 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-SilcConnectionType.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcConnectionType

    + + +NAME + +
    
+    typedef enum { ... } SilcConnectionType;
+
+
    +DESCRIPTION + +
    
+    The type of the connection.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_CONN_UNKNOWN  = 0,       /* Unknown type, cannot be sent */
+      SILC_CONN_CLIENT   = 1,       /* Client connection */
+      SILC_CONN_SERVER   = 2,       /* Server connection */
+      SILC_CONN_ROUTER   = 3        /* Router connection */
+    } SilcConnectionType;
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-silc_connauth_alloc.html b/docs/toolkit/manual/silcconnauth-silc_connauth_alloc.html new file mode 100644 index 0000000..2f8b89b --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-silc_connauth_alloc.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_connauth_alloc

    + + +SYNOPSIS + +
    
+    SilcConnAuth silc_connauth_alloc(SilcSchedule schedule, SilcSKE ske,
+                                     SilcUInt32 timeout_secs);
+
+
    +DESCRIPTION + +
    
+    Allocates the connection authentication protocol context.  The `ske'
+    is the successfully completed key exchange context.  The `timeout_secs'
+    is the maximum time we are waiting for the protocol to finish before
+    it is timedout.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-silc_connauth_free.html b/docs/toolkit/manual/silcconnauth-silc_connauth_free.html new file mode 100644 index 0000000..b15cb87 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-silc_connauth_free.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_connauth_free

    + + +SYNOPSIS + +
    
+    void silc_connauth_free(SilcConnAuth connauth);
+
+
    +DESCRIPTION + +
    
+    Frees the connection authentication protocol context `connauth'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-silc_connauth_get_ske.html b/docs/toolkit/manual/silcconnauth-silc_connauth_get_ske.html new file mode 100644 index 0000000..91fdd15 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-silc_connauth_get_ske.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_connauth_get_ske

    + + +SYNOPSIS + +
    
+    SilcSKE silc_connauth_get_ske(SilcConnAuth connauth);
+
+
    +DESCRIPTION + +
    
+    Returns the associated SilcSKE context from the `connauth'.  It is the
+    pointer given as argument to silc_connauth_alloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-silc_connauth_initiator.html b/docs/toolkit/manual/silcconnauth-silc_connauth_initiator.html new file mode 100644 index 0000000..ad34834 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-silc_connauth_initiator.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_connauth_initiator

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_connauth_initiator(SilcConnAuth connauth,
+                            SilcConnectionType conn_type,
+                            SilcAuthMethod auth_method, void *auth_data,
+                            SilcUInt32 auth_data_len,
+                            SilcConnAuthCompletion completion,
+                            void *context);
+
+
    +DESCRIPTION + +
    
+    Starts the connection authentication protocol as initiator.  The
+    `conn_type' is the type of connection we are.  The `auth_method' is
+    the authentication method.  If it is SILC_AUTH_PASSWORD the `auth_data'
+    and `auth_data_len' is the passphrase and its length, respectively.
+    If it is SILC_AUTH_PUBLIC_KEY the `auth_data' is the SilcPrivateKey
+    used to produce the digital signature.  The `auth_data_len' is 0.
+    The `completion' with `context' will be called after the protocol
+    has completed.
+
+    This returns SilcAsyncOperation context which can be used to abort
+    the protocol before it is completed.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth-silc_connauth_responder.html b/docs/toolkit/manual/silcconnauth-silc_connauth_responder.html new file mode 100644 index 0000000..1bde8c7 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth-silc_connauth_responder.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_connauth_responder

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_connauth_responder(SilcConnAuth connauth,
+                            SilcConnAuthGetAuthData get_auth_data,
+                            SilcConnAuthCompletion completion,
+                            void *context);
+
+
    +DESCRIPTION + +
    
+    Starts the connection authentication protocol as responder.  The
+    `get_auth_data' is called to retrieve the authentication data for
+    this connection.  The `completion' will be called after the protocol
+    has completed.
+
+    This returns SilcAsyncOperation context which can be used to abort
+    the protocol before it is completed.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Connection Authentication
    +SilcConnAuth
    +SilcConnectionType
    +SilcConnAuthGetAuthData
    +SilcConnAuthCompletion
    +silc_connauth_alloc
    +silc_connauth_free
    +silc_connauth_get_ske
    +silc_connauth_initiator
    +silc_connauth_responder
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth.html b/docs/toolkit/manual/silcconnauth.html new file mode 100644 index 0000000..7d0c780 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcconnauth.html + + + + +
    + +SILC Connection Authentication
    Header: silcconnauth.h

    + + +DESCRIPTION + +
    
+ SILC Connection Authenetication protocol API is used to perform the
+ connection authentication after successful SILC Key Exchange protocol.
+ The interface supports authentication based on passphrases and digital
+ signatures.  It is also possible to have no authentication at all.
+
+
  • SilcConnAuth +
  • SilcConnectionType +
  • SilcConnAuthGetAuthData +
  • SilcConnAuthCompletion +
  • silc_connauth_alloc +
  • silc_connauth_free +
  • silc_connauth_get_ske +
  • silc_connauth_initiator +
  • silc_connauth_responder + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcconnauth.xref b/docs/toolkit/manual/silcconnauth.xref new file mode 100644 index 0000000..81a3676 --- /dev/null +++ b/docs/toolkit/manual/silcconnauth.xref @@ -0,0 +1,16 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcconnauth.h" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 0 + "SILC Connection Authentication" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 1 + "SilcConnAuth" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 5 + "SilcConnectionType" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 8 + "SilcConnAuthGetAuthData" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 4 + "SilcConnAuthCompletion" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 4 + "silc_connauth_alloc" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 4 + "silc_connauth_free" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 4 + "silc_connauth_get_ske" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 4 + "silc_connauth_initiator" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 4 + "silc_connauth_responder" "/home/priikone/silc1/doc/toolkit/silcconnauth.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silccorelib.html b/docs/toolkit/manual/silccorelib.html new file mode 100644 index 0000000..8ba1404 --- /dev/null +++ b/docs/toolkit/manual/silccorelib.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Core Library +
    +Directory: lib/silccore/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Core Library includes all the core components of the SILC Protocol. +It provides routines to encode and decode all SILC packet payloads defined +in the protocol specification. It provides packet assembling and parsing +routines, and routines for sending private message and channel messages. + +

    + +
  • SILC Authentication Interface +
  • SILC Message Interface +
  • SILC Channel Interface +
  • SILC Command Interface +
  • SILC Notify Interface +
  • SILC Status Types +
  • SILC Modes +
  • SILC ID Interface +
  • SILC Argument Interface +
  • SILC Attributes Interface +
  • Packet Engine Interface +
  • SILC Public Key Payload Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silccryptlib.html b/docs/toolkit/manual/silccryptlib.html new file mode 100644 index 0000000..b953a52 --- /dev/null +++ b/docs/toolkit/manual/silccryptlib.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Crypto Library +
    +Directory: lib/silccrypt/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Crypto Library provides cryptographic routines for applications. It +provides interfaces for ciphers, hash functions, HMACs and public key +cryptosystems. In addition is also provides interfaces for cryptographically +strong random number generator. + +

    + +
  • Introduction to SILC RNG +
  • SILC RNG Interface +
  • SILC Cipher API +
  • SILC PKCS API +
  • SILC Public Key API +
  • SILC PKCS #1 API +
  • SILC Hash Interface +
  • SILC HMAC Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-SilcDH.html b/docs/toolkit/manual/silcdh-SilcDH.html new file mode 100644 index 0000000..09c8007 --- /dev/null +++ b/docs/toolkit/manual/silcdh-SilcDH.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcDH

    + + +NAME + +
     
+    typedef struct SilcDHStruct *SilcDH;
+
+
    +DESCRIPTION + +
    
+    This context is allocated by silc_dh_alloc and is given as argument
+    to all silc_dh_* functions.  It is freed by silc_dh_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-silc_dh_alloc.html b/docs/toolkit/manual/silcdh-silc_dh_alloc.html new file mode 100644 index 0000000..682342d --- /dev/null +++ b/docs/toolkit/manual/silcdh-silc_dh_alloc.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dh_alloc

    + + +SYNOPSIS + +
        
+    SilcDH silc_dh_alloc(SilcMPInt *g, SilcMPInt *p, SilcMPInt *lpf);
+ 
+
    +DESCRIPTION + +
    
+    Allocate SilcDH context. The `g' is the public base generator used
+    in the negotiation, the `p' is the public prime used in the
+    negotiation and the `lpf' is largest prime factor of p defined
+    publicly as well. The `lpf' is optional and if it is not supplied
+    then the private values generated satifies 0 < x < p - 1 instead
+    of 0 < x < lpf. Returns NULL on error or allocated SilcDH context
+    on success. 
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-silc_dh_compute_key.html b/docs/toolkit/manual/silcdh-silc_dh_compute_key.html new file mode 100644 index 0000000..c929008 --- /dev/null +++ b/docs/toolkit/manual/silcdh-silc_dh_compute_key.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dh_compute_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_dh_compute_key(SilcDH dh, const SilcMPInt **z);
+
+
    +DESCRIPTION + +
    
+    Computes the secret key z = y' ^ x mod p, and returns the key to the
+    `z' pointer sent as argument, unless the `z' is NULL. Returns FALSE if
+    the computation could not be performed. The returned `z' must not be
+    freed by the caller. 
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-silc_dh_compute_public.html b/docs/toolkit/manual/silcdh-silc_dh_compute_public.html new file mode 100644 index 0000000..5cb7d0c --- /dev/null +++ b/docs/toolkit/manual/silcdh-silc_dh_compute_public.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dh_compute_public

    + + +SYNOPSIS + +
    
+    SilcBool silc_dh_compute_public(SilcDH dh, const SilcMPInt **y);
+
+
    +DESCRIPTION + +
    
+    Computes the public key y = g ^ x mod p, and returns it to the `y'
+    pointer sent as argument, unless the `y' is NULL. Returns FALSE if
+    the computation could not be performed. The returned `y' must not be
+    freed by the caller. 
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-silc_dh_free.html b/docs/toolkit/manual/silcdh-silc_dh_free.html new file mode 100644 index 0000000..3ef5962 --- /dev/null +++ b/docs/toolkit/manual/silcdh-silc_dh_free.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dh_free

    + + +SYNOPSIS + +
    
+    void silc_dh_free(SilcDH dh);
+
+
    +DESCRIPTION + +
    
+    Free the SilcDH context. Frees all the allocated data inside the 
+    SilcDH context. 
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-silc_dh_generate_private.html b/docs/toolkit/manual/silcdh-silc_dh_generate_private.html new file mode 100644 index 0000000..6564ab2 --- /dev/null +++ b/docs/toolkit/manual/silcdh-silc_dh_generate_private.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dh_generate_private

    + + +SYNOPSIS + +
    
+    SilcBool silc_dh_generate_private(SilcDH dh, const SilcMPInt **x);
+
+
    +DESCRIPTION + +
    
+    Generates random private value `x' such that 0 < x < lpf at most of
+    length of lpf. Returns FALSE if the random number could not be generated.
+    Returns the generated value into `x' pointer sent as argument, unless
+    the `x' is NULL. The returned `x' must not be freed by the caller. 
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-silc_dh_remote_public(1).html b/docs/toolkit/manual/silcdh-silc_dh_remote_public(1).html new file mode 100644 index 0000000..fa9d224 --- /dev/null +++ b/docs/toolkit/manual/silcdh-silc_dh_remote_public(1).html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dh_remote_public(1)

    + + +SYNOPSIS + +
    
+    SilcBool silc_dh_compute_public(SilcDH dh, SilcMPInt *y);
+
+
    +DESCRIPTION + +
    
+    Sets the remote end's public value y' into the SilcDH context.
+    This must be done before computing the secret key. Returns FALSE 
+    on error. 
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh-silc_dh_remote_public.html b/docs/toolkit/manual/silcdh-silc_dh_remote_public.html new file mode 100644 index 0000000..60d0c3b --- /dev/null +++ b/docs/toolkit/manual/silcdh-silc_dh_remote_public.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dh_remote_public

    + + +SYNOPSIS + +
    
+    SilcBool silc_dh_compute_key_data(SilcDH dh, unsigned char **z, 
+                                  SilcUInt32 *z_len);
+
+
    +DESCRIPTION + +
    
+    Same as above but returns the computed secret key as octet binary
+    string.  The caller must free the returned binary string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silcdh.h
    +SilcDH
    +silc_dh_alloc
    +silc_dh_free
    +silc_dh_generate_private
    +silc_dh_compute_public
    +silc_dh_remote_public(1)
    +silc_dh_compute_key
    +silc_dh_remote_public
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh.html b/docs/toolkit/manual/silcdh.html new file mode 100644 index 0000000..d79dd8e --- /dev/null +++ b/docs/toolkit/manual/silcdh.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcdh.html + + + + +
    + +silcdh.h
    Header: silcdh.h

    + + +DESCRIPTION + +
    
+ PKCS #3 compliant Diffie Hellman key agreement protocol implementation.
+ This is used as part of SKE (SILC Key Exchange) protocol.
+
+
  • SilcDH +
  • silc_dh_alloc +
  • silc_dh_free +
  • silc_dh_generate_private +
  • silc_dh_compute_public +
  • silc_dh_remote_public(1) +
  • silc_dh_compute_key +
  • silc_dh_remote_public + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdh.xref b/docs/toolkit/manual/silcdh.xref new file mode 100644 index 0000000..724296d --- /dev/null +++ b/docs/toolkit/manual/silcdh.xref @@ -0,0 +1,15 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcdh.h" "/home/priikone/silc1/doc/toolkit/silcdh.html" 0 + "silcdh.h" "/home/priikone/silc1/doc/toolkit/silcdh.html" 1 + "SilcDH" "/home/priikone/silc1/doc/toolkit/silcdh.html" 5 + "silc_dh_alloc" "/home/priikone/silc1/doc/toolkit/silcdh.html" 4 + "silc_dh_free" "/home/priikone/silc1/doc/toolkit/silcdh.html" 4 + "silc_dh_generate_private" "/home/priikone/silc1/doc/toolkit/silcdh.html" 4 + "silc_dh_compute_public" "/home/priikone/silc1/doc/toolkit/silcdh.html" 4 + "silc_dh_remote_public(1)" "/home/priikone/silc1/doc/toolkit/silcdh.html" 4 + "silc_dh_compute_key" "/home/priikone/silc1/doc/toolkit/silcdh.html" 4 + "silc_dh_remote_public" "/home/priikone/silc1/doc/toolkit/silcdh.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcdlist-SilcDList.html b/docs/toolkit/manual/silcdlist-SilcDList.html new file mode 100644 index 0000000..1502143 --- /dev/null +++ b/docs/toolkit/manual/silcdlist-SilcDList.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcDList

    + + +NAME + +
    
+    typedef struct { ... } *SilcDList;
+
+
    +DESCRIPTION + +
    
+    This is the actual SilcDList object that is used by application.
+    Application defines this object and adds contexts to this list with
+    Dynamic List Interface functions.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_add.html b/docs/toolkit/manual/silcdlist-silc_dlist_add.html new file mode 100644 index 0000000..8c42f7d --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_add.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_add

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_dlist_add(SilcDList list, void *context);
+
+
    +DESCRIPTION + +
    
+    Adds new entry to the list. This is the default function to add new
+    entries to the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_count.html b/docs/toolkit/manual/silcdlist-silc_dlist_count.html new file mode 100644 index 0000000..90e11f4 --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_count.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_count

    + + +SYNOPSIS + +
    
+    static inline
+    int silc_dlist_count(SilcDList list);
+
+
    +DESCRIPTION + +
    
+ Return the number of entries in the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_del.html b/docs/toolkit/manual/silcdlist-silc_dlist_del.html new file mode 100644 index 0000000..21729cd --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_del.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_del

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_dlist_del(SilcDList list, void *entry);
+
+
    +DESCRIPTION + +
    
+    Remove entry from the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_end.html b/docs/toolkit/manual/silcdlist-silc_dlist_end.html new file mode 100644 index 0000000..4528ae4 --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_end.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_end

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_dlist_end(SilcDList list);
+
+
    +DESCRIPTION + +
    
+    Set the end of the list. This prepares the list for traversing entries
+    from the end of the list towards start of the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_get.html b/docs/toolkit/manual/silcdlist-silc_dlist_get.html new file mode 100644 index 0000000..39a4c17 --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_get.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_get

    + + +SYNOPSIS + +
    
+    static inline
+    void *silc_dlist_get(SilcDList list);
+
+
    +DESCRIPTION + +
    
+    Returns current entry from the list and moves the list pointer forward
+    so that calling this next time returns the next entry from the list.
+    This can be used to traverse the list. Return SILC_LIST_END when the
+    entire list has been traversed. Later, silc_list_start (or
+    silc_dlist_end) must be called again when re-starting list traversing.
+
+
    +EXAMPLE + +
    
+    // Traverse the list from the beginning to the end
+    silc_dlist_start(list)
+    while ((entry = silc_dlist_get(list)) != SILC_LIST_END) {
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_init.html b/docs/toolkit/manual/silcdlist-silc_dlist_init.html new file mode 100644 index 0000000..5122dbc --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_init.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_init

    + + +SYNOPSIS + +
    
+    static inline
+    SilcDList silc_dlist_init(void);
+
+
    +DESCRIPTION + +
    
+    Initializes SilcDList.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_insert.html b/docs/toolkit/manual/silcdlist-silc_dlist_insert.html new file mode 100644 index 0000000..dfcdcc0 --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_insert.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_insert

    + + +SYNOPSIS + +
    
+    static inline
+    SilcBool silc_dlist_insert(SilcDList list, void *context);
+
+
    +DESCRIPTION + +
    
+    Insert new entry to the list between current and previous entry.
+    If list is at the start this adds the entry at head of the list.
+    Use silc_dlist_add to add at the end of the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_start.html b/docs/toolkit/manual/silcdlist-silc_dlist_start.html new file mode 100644 index 0000000..eb7d4af --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_start.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_start

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_dlist_start(SilcDList list);
+
+
    +DESCRIPTION + +
    
+    Set the start of the list. This prepares the list for traversing entries
+    from the start of the list towards end of the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist-silc_dlist_uninit.html b/docs/toolkit/manual/silcdlist-silc_dlist_uninit.html new file mode 100644 index 0000000..bf0caeb --- /dev/null +++ b/docs/toolkit/manual/silcdlist-silc_dlist_uninit.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_dlist_uninit

    + + +SYNOPSIS + +
    
+    static inline
+    void silc_dlist_uninit(SilcDList list);
+
+
    +DESCRIPTION + +
    
+    Uninits and frees all memory. Must be called to free memory. Does NOT
+    free the contexts saved by caller.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Dynamic List Interface
    +SilcDList
    +silc_dlist_init
    +silc_dlist_uninit
    +silc_dlist_count
    +silc_dlist_start
    +silc_dlist_end
    +silc_dlist_add
    +silc_dlist_insert
    +silc_dlist_del
    +silc_dlist_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist.html b/docs/toolkit/manual/silcdlist.html new file mode 100644 index 0000000..5842cf8 --- /dev/null +++ b/docs/toolkit/manual/silcdlist.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcdlist.html + + + + +
    + +SILC Dynamic List Interface
    Header: silcdlist.h

    + + +DESCRIPTION + +
    
+ SILC Dynamic List API can be used to add opaque contexts to list that
+ will automatically allocate list entries.  Normal SILC List API cannot
+ be used for this purpose because in that case the context passed to the
+ list must be defined as list structure already.  This is not the case in
+ SilcDList.  But SilcDList is a bit slower than SilcList because it
+ requires memory allocation when adding new entries to the list.
+
+ SILC Dynamic List is not thread-safe.  If the same list context must be
+ used in multithreaded environment concurrency control must be employed.
+
+
  • SilcDList +
  • silc_dlist_init +
  • silc_dlist_uninit +
  • silc_dlist_count +
  • silc_dlist_start +
  • silc_dlist_end +
  • silc_dlist_add +
  • silc_dlist_insert +
  • silc_dlist_del +
  • silc_dlist_get + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcdlist.xref b/docs/toolkit/manual/silcdlist.xref new file mode 100644 index 0000000..87fb834 --- /dev/null +++ b/docs/toolkit/manual/silcdlist.xref @@ -0,0 +1,17 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcdlist.h" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 0 + "SILC Dynamic List Interface" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 1 + "SilcDList" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 5 + "silc_dlist_init" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_uninit" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_count" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_start" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_end" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_add" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_insert" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_del" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + "silc_dlist_get" "/home/priikone/silc1/doc/toolkit/silcdlist.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcdoc_xref b/docs/toolkit/manual/silcdoc_xref new file mode 100644 index 0000000..ecc6395 --- /dev/null +++ b/docs/toolkit/manual/silcdoc_xref @@ -0,0 +1,87 @@ +/home/priikone/silc1/doc/toolkit/silcsftp_fs.xref +/home/priikone/silc1/doc/toolkit/silcsftp.xref +/home/priikone/silc1/doc/toolkit/silcexample.xref +/home/priikone/silc1/doc/toolkit/silcidcache.xref +/home/priikone/silc1/doc/toolkit/silcapputil.xref +/home/priikone/silc1/doc/toolkit/silcskr.xref +/home/priikone/silc1/doc/toolkit/silcskr_i.xref +/home/priikone/silc1/doc/toolkit/silcschedule_i.xref +/home/priikone/silc1/doc/toolkit/silclist.xref +/home/priikone/silc1/doc/toolkit/silcmime_i.xref +/home/priikone/silc1/doc/toolkit/silclog_i.xref +/home/priikone/silc1/doc/toolkit/silcthread.xref +/home/priikone/silc1/doc/toolkit/silcsymbiansocketstream.xref +/home/priikone/silc1/doc/toolkit/silcstream.xref +/home/priikone/silc1/doc/toolkit/silcfdstream.xref +/home/priikone/silc1/doc/toolkit/silchashtable.xref +/home/priikone/silc1/doc/toolkit/silcnet_i.xref +/home/priikone/silc1/doc/toolkit/silcasync_i.xref +/home/priikone/silc1/doc/toolkit/silcsnprintf.xref +/home/priikone/silc1/doc/toolkit/silcasync.xref +/home/priikone/silc1/doc/toolkit/silcschedule.xref +/home/priikone/silc1/doc/toolkit/silcstringprep.xref +/home/priikone/silc1/doc/toolkit/silccond.xref +/home/priikone/silc1/doc/toolkit/silcdlist.xref +/home/priikone/silc1/doc/toolkit/silcbuffer.xref +/home/priikone/silc1/doc/toolkit/silcbuffmt.xref +/home/priikone/silc1/doc/toolkit/silcconfig.xref +/home/priikone/silc1/doc/toolkit/silcstack_i.xref +/home/priikone/silc1/doc/toolkit/silcmemory.xref +/home/priikone/silc1/doc/toolkit/silcstrutil.xref +/home/priikone/silc1/doc/toolkit/silcstack.xref +/home/priikone/silc1/doc/toolkit/silctypes.xref +/home/priikone/silc1/doc/toolkit/silctime.xref +/home/priikone/silc1/doc/toolkit/silcmime.xref +/home/priikone/silc1/doc/toolkit/silcsocketstream.xref +/home/priikone/silc1/doc/toolkit/silcsocketstream_i.xref +/home/priikone/silc1/doc/toolkit/silcutf8.xref +/home/priikone/silc1/doc/toolkit/silcatomic.xref +/home/priikone/silc1/doc/toolkit/silclog.xref +/home/priikone/silc1/doc/toolkit/silcutil.xref +/home/priikone/silc1/doc/toolkit/silcfsm_i.xref +/home/priikone/silc1/doc/toolkit/silcfileutil.xref +/home/priikone/silc1/doc/toolkit/silcfsm.xref +/home/priikone/silc1/doc/toolkit/silcnet.xref +/home/priikone/silc1/doc/toolkit/silcmutex.xref +/home/priikone/silc1/doc/toolkit/silchttpphp.xref +/home/priikone/silc1/doc/toolkit/silchttpserver.xref +/home/priikone/silc1/doc/toolkit/silcsimutil.xref +/home/priikone/silc1/doc/toolkit/silcsim.xref +/home/priikone/silc1/doc/toolkit/silcasn1_i.xref +/home/priikone/silc1/doc/toolkit/silcber.xref +/home/priikone/silc1/doc/toolkit/silcasn1.xref +/home/priikone/silc1/doc/toolkit/silcclient.xref +/home/priikone/silc1/doc/toolkit/silcclient_entry.xref +/home/priikone/silc1/doc/toolkit/silcmp.xref +/home/priikone/silc1/doc/toolkit/silcmath.xref +/home/priikone/silc1/doc/toolkit/silcvcard.xref +/home/priikone/silc1/doc/toolkit/silcske_i.xref +/home/priikone/silc1/doc/toolkit/silcske.xref +/home/priikone/silc1/doc/toolkit/silcconnauth.xref +/home/priikone/silc1/doc/toolkit/silcske_groups.xref +/home/priikone/silc1/doc/toolkit/silcske_payload.xref +/home/priikone/silc1/doc/toolkit/silcchannel.xref +/home/priikone/silc1/doc/toolkit/silcpubkey.xref +/home/priikone/silc1/doc/toolkit/silccommand.xref +/home/priikone/silc1/doc/toolkit/silcid.xref +/home/priikone/silc1/doc/toolkit/silcmode.xref +/home/priikone/silc1/doc/toolkit/silcmessage.xref +/home/priikone/silc1/doc/toolkit/silcmessage_i.xref +/home/priikone/silc1/doc/toolkit/silcargument.xref +/home/priikone/silc1/doc/toolkit/silcauth.xref +/home/priikone/silc1/doc/toolkit/silcstatus.xref +/home/priikone/silc1/doc/toolkit/silcpacket.xref +/home/priikone/silc1/doc/toolkit/silcattrs.xref +/home/priikone/silc1/doc/toolkit/silcnotify.xref +/home/priikone/silc1/doc/toolkit/silchmac.xref +/home/priikone/silc1/doc/toolkit/silcrng.xref +/home/priikone/silc1/doc/toolkit/silcpk_i.xref +/home/priikone/silc1/doc/toolkit/silccipher.xref +/home/priikone/silc1/doc/toolkit/silcpkcs.xref +/home/priikone/silc1/doc/toolkit/silcdh.xref +/home/priikone/silc1/doc/toolkit/silcpk.xref +/home/priikone/silc1/doc/toolkit/silcpkcs1.xref +/home/priikone/silc1/doc/toolkit/silcpkcs1_i.xref +/home/priikone/silc1/doc/toolkit/silchash.xref +/home/priikone/silc1/doc/toolkit/silcserver.xref +/home/priikone/silc1/doc/toolkit/silcserver_params.xref diff --git a/docs/toolkit/manual/silcexample-SilcExampleStruct.html b/docs/toolkit/manual/silcexample-SilcExampleStruct.html new file mode 100644 index 0000000..6165680 --- /dev/null +++ b/docs/toolkit/manual/silcexample-SilcExampleStruct.html @@ -0,0 +1,214 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcExampleStruct

    + + +NAME + +
    
+    typedef struct { ... } SilcExampleStruct;
+
+
    +DESCRIPTION + +
    
+    Example structure definition.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcExampleAPI
    +SilcExampleType
    +SilcExampleStruct
    +silc_example_function
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcexample-SilcExampleType.html b/docs/toolkit/manual/silcexample-SilcExampleType.html new file mode 100644 index 0000000..246bc5a --- /dev/null +++ b/docs/toolkit/manual/silcexample-SilcExampleType.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcExampleType

    + + +NAME + +
    
+    typedef enum { ... } SilcExampleTyle;
+
+
    +DESCRIPTION + +
    
+    Example type definition with the actual source code.
+
+
    +SOURCE + +
        /* Source code from the actual header file is appended */
+    typedef enum {
+      SILC_EXAMPLE_1,
+      SILC_EXAMPLE_2,
+      SILC_EXAMPLE_3,
+    } SilcExampleType;
    +



    +
    +     		+ + + + +
    +
    + +SilcExampleAPI
    +SilcExampleType
    +SilcExampleStruct
    +silc_example_function
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcexample-silc_example_function.html b/docs/toolkit/manual/silcexample-silc_example_function.html new file mode 100644 index 0000000..778976b --- /dev/null +++ b/docs/toolkit/manual/silcexample-silc_example_function.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_example_function

    + + +SYNOPSIS + +
    
+    bool silc_example_function(SilcExampleType type);
+
+
    +DESCRIPTION + +
    
+    Description of the silc_example_function.
+
+
    +NOTES + +
    
+    There may be additional notes that programmers should be aware of
+    for this function.
+
+
    +EXAMPLE + +
    
+    if (!silc_example_function(SILC_EXAMPLE_1))
+      SILC_LOG_ERROR(("Error occurred during example function"));
+
+
    +SEE ALSO + +
    +    SilcExampleType, SILC_LOG_ERROR, SilcExampleStruct
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcExampleAPI
    +SilcExampleType
    +SilcExampleStruct
    +silc_example_function
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcexample.html b/docs/toolkit/manual/silcexample.html new file mode 100644 index 0000000..29ba38c --- /dev/null +++ b/docs/toolkit/manual/silcexample.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcexample.html + + + + +
    + +SilcExampleAPI
    Header: silcexample.h

    + + +DESCRIPTION + +
    
+ This is example API providing the examples of how API items may appear
+ in the Toolkit Reference Manual.  This example includes all aspects of
+ a reference, however, note that all API items that appear in the manual
+ may not include all of the information that are presented here.
+
+
  • SilcExampleType +
  • SilcExampleStruct +
  • silc_example_function + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcexample.xref b/docs/toolkit/manual/silcexample.xref new file mode 100644 index 0000000..1abf49a --- /dev/null +++ b/docs/toolkit/manual/silcexample.xref @@ -0,0 +1,10 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcexample.h" "/home/priikone/silc1/doc/toolkit/silcexample.html" 0 + "SilcExampleAPI" "/home/priikone/silc1/doc/toolkit/silcexample.html" 1 + "SilcExampleType" "/home/priikone/silc1/doc/toolkit/silcexample.html" 8 + "SilcExampleStruct" "/home/priikone/silc1/doc/toolkit/silcexample.html" 5 + "silc_example_function" "/home/priikone/silc1/doc/toolkit/silcexample.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcfdstream-silc_fd_stream_create.html b/docs/toolkit/manual/silcfdstream-silc_fd_stream_create.html new file mode 100644 index 0000000..049fd12 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream-silc_fd_stream_create.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fd_stream_create

    + + +SYNOPSIS + +
    
+    SilcStream silc_fd_stream_create(int fd);
+
+
    +DESCRIPTION + +
    
+    Creates file descriptor stream for the open file descriptor indicated
+    by `fd'.  The stream is closed with the silc_stream_close and destroyed
+    with the silc_stream_destroy.
+
+    If the silc_stream_set_notifier is called the stream is set to
+    non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Descriptor Stream Interface
    +silc_fd_stream_create
    +silc_fd_stream_create2
    +silc_fd_stream_file
    +silc_fd_stream_file2
    +silc_fd_stream_get_info
    +silc_fd_stream_get_error
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfdstream-silc_fd_stream_create2.html b/docs/toolkit/manual/silcfdstream-silc_fd_stream_create2.html new file mode 100644 index 0000000..728df12 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream-silc_fd_stream_create2.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fd_stream_create2

    + + +SYNOPSIS + +
    
+    SilcStream silc_fd_stream_create2(int read_fd, int write_fd);
+
+
    +DESCRIPTION + +
    
+    Creates file descriptor stream for the open file descriptors indicated
+    by `read_fd' and `write_fd'.  The `read_fd' must be opened for reading
+    and `write_fd' opened for writing.  The stream is closed with the
+    silc_stream_close and destroyed with the silc_stream_destroy.
+
+    If the silc_stream_set_notifier is called the stream is set to
+    non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Descriptor Stream Interface
    +silc_fd_stream_create
    +silc_fd_stream_create2
    +silc_fd_stream_file
    +silc_fd_stream_file2
    +silc_fd_stream_get_info
    +silc_fd_stream_get_error
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfdstream-silc_fd_stream_file.html b/docs/toolkit/manual/silcfdstream-silc_fd_stream_file.html new file mode 100644 index 0000000..c070da3 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream-silc_fd_stream_file.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fd_stream_file

    + + +SYNOPSIS + +
    
+    SilcStream silc_fd_stream_file(const char *filename, SilcBool reading,
+                                   SilcBool writing);
+
+
    +DESCRIPTION + +
    
+    Same as silc_fd_stream_create but creates the stream by opening the
+    file indicated by `filename'.  If the `reading' is TRUE the file is
+    opened for reading.  If the `writing' is TRUE the file is opened
+    for writing.
+
+    If the silc_stream_set_notifier is called the stream is set to
+    non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Descriptor Stream Interface
    +silc_fd_stream_create
    +silc_fd_stream_create2
    +silc_fd_stream_file
    +silc_fd_stream_file2
    +silc_fd_stream_get_info
    +silc_fd_stream_get_error
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfdstream-silc_fd_stream_file2.html b/docs/toolkit/manual/silcfdstream-silc_fd_stream_file2.html new file mode 100644 index 0000000..e6a6971 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream-silc_fd_stream_file2.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fd_stream_file2

    + + +SYNOPSIS + +
    
+    SilcStream silc_fd_stream_file2(const char *read_file,
+                                    const char *write_file);
+
+
    +DESCRIPTION + +
    
+    Same as silc_fd_stream_file but creates the stream by opening `read_file'
+    for reading and `write_file' for writing.
+
+    If the silc_stream_set_notifier is called the stream is set to
+    non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Descriptor Stream Interface
    +silc_fd_stream_create
    +silc_fd_stream_create2
    +silc_fd_stream_file
    +silc_fd_stream_file2
    +silc_fd_stream_get_info
    +silc_fd_stream_get_error
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfdstream-silc_fd_stream_get_error.html b/docs/toolkit/manual/silcfdstream-silc_fd_stream_get_error.html new file mode 100644 index 0000000..66a8020 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream-silc_fd_stream_get_error.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fd_stream_get_error

    + + +SYNOPSIS + +
    
+    int silc_fd_stream_get_error(SilcStream stream);
+
+
    +DESCRIPTION + +
    
+    If error occurred during file descriptor stream operations, this
+    function can be used to retrieve the error number that occurred.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Descriptor Stream Interface
    +silc_fd_stream_create
    +silc_fd_stream_create2
    +silc_fd_stream_file
    +silc_fd_stream_file2
    +silc_fd_stream_get_info
    +silc_fd_stream_get_error
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfdstream-silc_fd_stream_get_info.html b/docs/toolkit/manual/silcfdstream-silc_fd_stream_get_info.html new file mode 100644 index 0000000..2deb8a9 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream-silc_fd_stream_get_info.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fd_stream_get_info

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_fd_stream_get_info(SilcStream stream, int *read_fd, int *write_fd);
+
+
    +DESCRIPTION + +
    
+    Returns the file descriptors associated with the stream.  The 'write_fd'
+    is available only if the stream was created with silc_fd_stream_create2
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Descriptor Stream Interface
    +silc_fd_stream_create
    +silc_fd_stream_create2
    +silc_fd_stream_file
    +silc_fd_stream_file2
    +silc_fd_stream_get_info
    +silc_fd_stream_get_error
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfdstream.html b/docs/toolkit/manual/silcfdstream.html new file mode 100644 index 0000000..4ec0f31 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcfdstream.html + + + + +
    + +SILC File Descriptor Stream Interface
    Header: silcfdstream.h

    + + +DESCRIPTION + +
    
+ Implementation of SILC File Descriptor Stream.  The file descriptor
+ stream can be used read from and write to a file descriptor.  This
+ interface should be used only with real file descriptors, not with
+ sockets.  Use the SILC Socket Stream for sockets.
+
+ SILC File Descriptor Stream is not thread-safe.  If same stream must be
+ used in multithreaded environment concurrency control must be employed.
+
+
  • silc_fd_stream_create +
  • silc_fd_stream_create2 +
  • silc_fd_stream_file +
  • silc_fd_stream_file2 +
  • silc_fd_stream_get_info +
  • silc_fd_stream_get_error + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfdstream.xref b/docs/toolkit/manual/silcfdstream.xref new file mode 100644 index 0000000..effd937 --- /dev/null +++ b/docs/toolkit/manual/silcfdstream.xref @@ -0,0 +1,13 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcfdstream.h" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 0 + "SILC File Descriptor Stream Interface" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 1 + "silc_fd_stream_create" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 4 + "silc_fd_stream_create2" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 4 + "silc_fd_stream_file" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 4 + "silc_fd_stream_file2" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 4 + "silc_fd_stream_get_info" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 4 + "silc_fd_stream_get_error" "/home/priikone/silc1/doc/toolkit/silcfdstream.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcfileutil-silc_file_close.html b/docs/toolkit/manual/silcfileutil-silc_file_close.html new file mode 100644 index 0000000..bc57837 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_close.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_close

    + + +SYNOPSIS + +
    
+    int silc_file_close(int fd);
+
+
    +DESCRIPTION + +
    
+    Closes file descriptor previously opened with silc_file_open().
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_open.html b/docs/toolkit/manual/silcfileutil-silc_file_open.html new file mode 100644 index 0000000..618b5b4 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_open.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_open

    + + +SYNOPSIS + +
    
+    int silc_file_open(const char *filename, int flags);
+
+
    +DESCRIPTION + +
    
+    Opens a file indicated by the filename `filename' with flags indicated
+    by `flags'.  The opening permission defaults to 0600.  The `flags'
+    are defined in open(2).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_open_mode.html b/docs/toolkit/manual/silcfileutil-silc_file_open_mode.html new file mode 100644 index 0000000..317f464 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_open_mode.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_open_mode

    + + +SYNOPSIS + +
    
+    int silc_file_open_mode(const char *filename, int flags, int mode);
+
+
    +DESCRIPTION + +
    
+    Opens a file indicated by the filename `filename' with flags indicated
+    by `flags'.  The argument `mode' specifies the permissions to use in
+    case a new file is created.  The `flags' are defined in open(2).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_read.html b/docs/toolkit/manual/silcfileutil-silc_file_read.html new file mode 100644 index 0000000..509e0ac --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_read.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_read

    + + +SYNOPSIS + +
    
+    int silc_file_read(int fd, unsigned char *buf, SilcUInt32 buf_len);
+
+
    +DESCRIPTION + +
    
+    Reads data from file descriptor `fd' to `buf'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_readfile.html b/docs/toolkit/manual/silcfileutil-silc_file_readfile.html new file mode 100644 index 0000000..f76dd97 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_readfile.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_readfile

    + + +SYNOPSIS + +
    
+    char *silc_file_readfile(const char *filename, SilcUInt32 *return_len);
+
+
    +DESCRIPTION + +
    
+    Reads the content of `filename' to a buffer.  The allocated buffer is
+    returned.  This does not NULL terminate the buffer but EOF terminate
+    it.  The caller must replace the EOF with NULL if the buffer must be
+    NULL terminated.
+
+    If the `return_len' pointer is not NULL, it's filled with the length of
+    the file.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_set_nonblock.html b/docs/toolkit/manual/silcfileutil-silc_file_set_nonblock.html new file mode 100644 index 0000000..35b4dee --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_set_nonblock.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_set_nonblock

    + + +SYNOPSIS + +
    
+    int silc_file_set_nonblock(int fd);
+
+
    +DESCRIPTION + +
    
+    Sets the file descriptor to non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_size.html b/docs/toolkit/manual/silcfileutil-silc_file_size.html new file mode 100644 index 0000000..4ebc7f3 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_size.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_size

    + + +SYNOPSIS + +
    
+    SilcUInt64 silc_file_size(const char *filename);
+
+
    +DESCRIPTION + +
    
+    Returns the size of `filename'. Returns 0 on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_write.html b/docs/toolkit/manual/silcfileutil-silc_file_write.html new file mode 100644 index 0000000..88e33c5 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_write.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_write

    + + +SYNOPSIS + +
    
+    int silc_file_write(int fd, const char *buffer, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Writes `buffer' of length of `len' to file descriptor `fd'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_writefile.html b/docs/toolkit/manual/silcfileutil-silc_file_writefile.html new file mode 100644 index 0000000..c034985 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_writefile.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_writefile

    + + +SYNOPSIS + +
    
+    int silc_file_writefile(const char *filename, const char *buffer,
+                            SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Writes a buffer to the file.  If the file is created specific mode is
+    set to the file.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil-silc_file_writefile_mode.html b/docs/toolkit/manual/silcfileutil-silc_file_writefile_mode.html new file mode 100644 index 0000000..a4e4eb0 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil-silc_file_writefile_mode.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_file_writefile_mode

    + + +SYNOPSIS + +
    
+    int silc_file_writefile_mode(const char *filename, const char *buffer,
+                                 SilcUInt32 len, int mode);
+
+
    +DESCRIPTION + +
    
+    Writes a buffer to the file.  If the file is created the specified `mode'
+    is set to the file.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC File Util Interface
    +silc_file_open
    +silc_file_open_mode
    +silc_file_read
    +silc_file_write
    +silc_file_close
    +silc_file_set_nonblock
    +silc_file_readfile
    +silc_file_writefile
    +silc_file_writefile_mode
    +silc_file_size
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil.html b/docs/toolkit/manual/silcfileutil.html new file mode 100644 index 0000000..d9c5747 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcfileutil.html + + + + +
    + +SILC File Util Interface
    Header: silcfileutil.h

    + + +DESCRIPTION + +
    
+    The SILC File Util Interface is a small set of functions that provides a
+    portable access method to the filesystem.
+
+
  • silc_file_open +
  • silc_file_open_mode +
  • silc_file_read +
  • silc_file_write +
  • silc_file_close +
  • silc_file_set_nonblock +
  • silc_file_readfile +
  • silc_file_writefile +
  • silc_file_writefile_mode +
  • silc_file_size + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfileutil.xref b/docs/toolkit/manual/silcfileutil.xref new file mode 100644 index 0000000..e6edeb8 --- /dev/null +++ b/docs/toolkit/manual/silcfileutil.xref @@ -0,0 +1,17 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcfileutil.h" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 0 + "SILC File Util Interface" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 1 + "silc_file_open" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_open_mode" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_read" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_write" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_close" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_set_nonblock" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_readfile" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_writefile" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_writefile_mode" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + "silc_file_size" "/home/priikone/silc1/doc/toolkit/silcfileutil.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_CALL.html b/docs/toolkit/manual/silcfsm-SILC_FSM_CALL.html new file mode 100644 index 0000000..e7672fb --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_CALL.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_CALL

    + + +NAME + +
    
+    SILC_FSM_CALL(function)
+
+
    +DESCRIPTION + +
    
+    Macro used to call asynchronous calls from state function.  If the
+    call is not really asynchronous then this will cause the machine to
+    directly proceed to next state.  If the call is truly asynchronous
+    then this will set the machine to wait state.  The silc_fsm_next
+    must be called before this macro, so that the next state is set.
+
+
    +NOTES + +
    
+    The state function returns in this macro.
+
+
    +EXAMPLE + +
    
+    // Simple example
+    silc_fsm_next(fsm, some_next_state);
+    SILC_FSM_CALL(silc_some_async_call(server, some_callback, context));
+
+    // More complex example
+    silc_fsm_next(fsm, some_next_state);
+    SILC_FSM_CALL((some_context->operation =
+                   silc_some_async_call(server, some_callback, context)));
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE.html b/docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE.html new file mode 100644 index 0000000..fe09a99 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_CALL_CONTINUE

    + + +NAME + +
    
+    SILC_FSM_CALL_CONTINUE(fsm)
+
+
    +DESCRIPTION + +
    
+    Macro used to proceed after asynchornous call.  This is called in the
+    callback of the asynchronous call to continue in the state machine.
+
+
    +EXAMPLE + +
    
+    void some_callback(void *context) {
+      SilcFSM fsm = context;
+      ...
+      // Continue to the next state
+      SILC_FSM_CALL_CONTINUE(fsm);
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE_SYNC.html b/docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE_SYNC.html new file mode 100644 index 0000000..6c60361 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_CALL_CONTINUE_SYNC.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_CALL_CONTINUE_SYNC

    + + +NAME + +
    
+    SILC_FSM_CALL_CONTINUE_SYNC(fsm)
+
+
    +DESCRIPTION + +
    
+    Macro used to proceed after asynchornous call.  This is called in the
+    callback of the asynchronous call to continue in the state machine.
+    This continues to the next state synchronously, not through the
+    scheduler.
+
+
    +EXAMPLE + +
    
+    void some_callback(void *context) {
+      SilcFSM fsm = context;
+      ...
+      // Continue to the next state immediately
+      SILC_FSM_CALL_CONTINUE_SYNC(fsm);
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_CONTINUE.html b/docs/toolkit/manual/silcfsm-SILC_FSM_CONTINUE.html new file mode 100644 index 0000000..cfd4e26 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_CONTINUE.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_CONTINUE

    + + +NAME + +
    
+    #define SILC_FSM_CONTINUE ...
+
+
    +DESCRIPTION + +
    
+    Moves to next state synchronously.  This type is used is returned
+    from state functions to immediately move to next state.
+
+
    +EXAMPLE + +
    
+    SILC_FSM_STATE(silc_foo_state)
+    {
+      ...
+
+      // Move to next state now
+      silc_fsm_next(fsm, silc_foo_next_state);
+      return SILC_FSM_CONTINUE;
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_SIGNAL.html b/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_SIGNAL.html new file mode 100644 index 0000000..b766776 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_SIGNAL.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SILC_FSM_EVENT_SIGNAL

    + + +SYNOPSIS + +
    
+    SILC_FSM_EVENT_SIGNAL(event)
+
+
    +DESCRIPTION + +
    
+    Signals the `event' and awakens everybody that are waiting for this
+    event.  This macro never blocks.  It can be safely called at any place
+    in state function and in asynchronous callbacks or other functions.
+
+
    +EXAMPLE + +
    
+    SILC_FSM_STATE(silc_foo_async_completion)
+    {
+      ...
+
+      // Notify all waiters
+      ctx->async_success = TRUE;
+      SILC_FSM_EVENT_SIGNAL(ctx->async_event);
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_TIMEDWAIT.html b/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_TIMEDWAIT.html new file mode 100644 index 0000000..e5744bb --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_TIMEDWAIT.html @@ -0,0 +1,283 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_EVENT_TIMEDWAIT

    + + +NAME + +
    
+    SILC_FSM_EVENT_TIMEDWAIT(event, seconds, useconds, timedout)
+
+
    +DESCRIPTION + +
    
+    Macro used to wait for the `event' to be signalled, or until
+    the timeout specified by `seconds' and `useconds' has elapsed.  If
+    the timeout occurs before the event is signalled, the machine
+    will wakeup.  The `timedout' is SilcBool pointer and if it is
+    non-NULL indication of whether timeout occurred or not is saved to
+    the pointer.  This macro can only be used in FSM state functions.
+    When the event is signalled or timedout the FSM will re-enter
+    the current state (or state that was set with silc_fsm_next before
+    waiting).
+
+
    +EXAMPLE + +
    
+    SILC_FSM_STATE(silc_foo_state)
+    {
+      SilcBool timedout;
+      ...
+
+      // Wait here for async call to complete, or 10 seconds for timeout
+      SILC_FSM_EVENT_TIMEDWAIT(ctx->async_event, 10, 0, &timedout);
+
+      // See if timeout occurred
+      if (timedout == TRUE)
+        fatal(error);
+
+      // Async call completed
+      if (ctx->async_success == FALSE)
+        fatal(error);
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_WAIT.html b/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_WAIT.html new file mode 100644 index 0000000..48082b5 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_EVENT_WAIT.html @@ -0,0 +1,278 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_EVENT_WAIT

    + + +NAME + +
    
+    SILC_FSM_EVENT_WAIT(event)
+
+
    +DESCRIPTION + +
    
+    Macro used to wait for the `event' to be signalled.  The machine
+    or thread will be suspended while it is waiting for the event.
+    This macro can only be used in FSM state functions.  When the
+    event is signalled the FSM will re-enter the current state (or
+    state that was set with silc_fsm_next before waiting).
+
+
    +EXAMPLE + +
    
+    // Signalling example
+    ctx->async_event = silc_fsm_event_alloc(fsm);
+    ...
+
+    SILC_FSM_STATE(silc_foo_state)
+    {
+      ...
+
+      // Wait here for async call to complete
+      SILC_FSM_EVENT_WAIT(ctx->async_event);
+
+      // Async call completed
+      if (ctx->async_success == FALSE)
+        fatal(error);
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_FINISH.html b/docs/toolkit/manual/silcfsm-SILC_FSM_FINISH.html new file mode 100644 index 0000000..2608b71 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_FINISH.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_FINISH

    + + +NAME + +
    
+    #define SILC_FSM_FINISH ...
+
+
    +DESCRIPTION + +
    
+    Finishes the machine or thread and calls its destructor, if defined.
+    If the machine is finished when it has running threads the machine
+    will fatally fail.  User must always finish the threads before
+    finishing the machine.  This type is returned in the state function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_STATE.html b/docs/toolkit/manual/silcfsm-SILC_FSM_STATE.html new file mode 100644 index 0000000..f859a77 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_STATE.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_STATE

    + + +NAME + +
    
+    #define SILC_FSM_STATE(name)
+
+
    +DESCRIPTION + +
    
+    This macro is used to declare an FSM state function.  The `fsm' is
+    the SilcFSM or SilcFSMThread context, the `fsm_context' is the context
+    given as argument to silc_fsm_alloc, silc_fsm_init, silc_fsm_thread_init,
+    or silc_fsm_thread_alloc function.  The `state_context' is the optional
+    state specific context set with silc_fsm_set_state_context function.
+
+
    +SOURCE + +
        #define SILC_FSM_STATE(name)                                            \
+    int name(struct SilcFSMObject *fsm, void *fsm_context, void *state_context)
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_THREAD_WAIT.html b/docs/toolkit/manual/silcfsm-SILC_FSM_THREAD_WAIT.html new file mode 100644 index 0000000..226b8e1 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_THREAD_WAIT.html @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_THREAD_WAIT

    + + +NAME + +
    
+    SILC_FSM_THREAD_WAIT(thread)
+
+
    +DESCRIPTION + +
    
+    Macro used to wait for the `thread' to terminate.  The machine or
+    thread will be suspended while it is waiting for the thread to
+    terminate.  The machine or thread will continue once the waited
+    thread has terminated.
+
+
    +NOTES + +
    
+    The state function returns in this macro.
+
+    This macro is the only way to safely make sure that the thread has
+    terminated by the time FSM continues from the waiting state.  Using
+    FSM events to signal from the thread before SILC_FSM_FINISH is returned
+    works with normal FSM threads, but especially with real system threads
+    it does not guarantee that the FSM won't continue before the thread has
+    actually terminated.  Usually this is not a problem, but it can be a
+    problem if the FSM is waiting to be freed.  In this case using this
+    macro is strongly recommended.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_WAIT.html b/docs/toolkit/manual/silcfsm-SILC_FSM_WAIT.html new file mode 100644 index 0000000..9e6f5dc --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_WAIT.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_WAIT

    + + +NAME + +
    
+    #define SILC_FSM_WAIT ...
+
+
    +DESCRIPTION + +
    
+    Suspends the machine or thread until it is awaken.  This is used
+    when asynchronous call is made or timer is set, or something else
+    that requires waiting.  This type is returned in the state function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SILC_FSM_YIELD.html b/docs/toolkit/manual/silcfsm-SILC_FSM_YIELD.html new file mode 100644 index 0000000..7d37d99 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SILC_FSM_YIELD.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_FSM_YIELD

    + + +NAME + +
    
+    #define SILC_FSM_YIELD ...
+
+
    +DESCRIPTION + +
    
+    Moves to next state through the machine scheduler.  Other threads
+    running in the machine will get running time with SILC_FSM_YIELD.
+    When using real threads, using SILC_FSM_YIELD is usually unnecessary.
+    This type is returned in the state function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSM.html b/docs/toolkit/manual/silcfsm-SilcFSM.html new file mode 100644 index 0000000..d86ab5c --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSM.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcFSM

    + + +NAME + +
    
+    typedef struct SilcFSMObject *SilcFSM;
+
+
    +DESCRIPTION + +
    
+    The actual FSM context and is allocated with silc_fsm_alloc and
+    given as argument to all silc_fsm_* functions.  It is freed by
+    silc_fsm_free function.  It is also possible to use pre-allocated
+    FSM context by using SilcFSMStruct instead of SilcFSM.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSMDestructor.html b/docs/toolkit/manual/silcfsm-SilcFSMDestructor.html new file mode 100644 index 0000000..d7dbe8a --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSMDestructor.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcFSMDestructor

    + + +SYNOPSIS + +
    
+    typedef void (*SilcFSMDestructor)(SilcFSM fsm, void *fsm_context,
+                                      void *destructor_context);
+
+
    +DESCRIPTION + +
    
+    The destructor callback that was set in silc_fsm_alloc or in
+    silc_fsm_init function.  It will be called when a state function
+    returns SILC_FSM_FINISH.  This function will be called through
+    the scheduler; it will not be called immediately after the state
+    function returns SILC_FSM_FINISH, but will be called later.  The
+    `fsm' can be freed in this function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSMEvent.html b/docs/toolkit/manual/silcfsm-SilcFSMEvent.html new file mode 100644 index 0000000..f0a8db1 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSMEvent.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcFSMEvent

    + + +NAME + +
    
+    typedef struct SilcFSMEventObject *SilcFSMEvent;
+
+
    +DESCRIPTION + +
    
+    The FSM event context allocated with silc_fsm_event_alloc.  The
+    caller must free it with silc_fsm_event_free.  It is also possible
+    to use pre-allocated SilcFSMEventStruct instead of SilcFSMEvent context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSMEventStruct.html b/docs/toolkit/manual/silcfsm-SilcFSMEventStruct.html new file mode 100644 index 0000000..065d1fe --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSMEventStruct.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcFSMEventStruct

    + + +NAME + +
    
+    typedef struct SilcFSMEventObject SilcFSMEventStruct;
+
+
    +DESCRIPTION + +
    
+    The FSM event context that can be used as pre-allocated context.
+    It is initialized with silc_fsm_event_init.  It need not be
+    uninitialized.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSMStruct.html b/docs/toolkit/manual/silcfsm-SilcFSMStruct.html new file mode 100644 index 0000000..3543639 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSMStruct.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcFSMStruct

    + + +NAME + +
    
+    typedef struct SilcFSMObject SilcFSMStruct;
+
+
    +DESCRIPTION + +
    
+    The actual FSM context and can be used as pre-allocated FSM context,
+    instead of SilcFSM context.  This context is initialized with the
+    silc_fsm_init function.  It need not be uninitialized.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSMThread.html b/docs/toolkit/manual/silcfsm-SilcFSMThread.html new file mode 100644 index 0000000..3bb848a --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSMThread.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcFSMThread

    + + +NAME + +
    
+    typedef struct SilcFSMObject *SilcFSMThread;
+
+
    +DESCRIPTION + +
    
+    FSM thread context.  The SILC FSM supports threads, virtual machine
+    threads (inside FSM) and actual real system threads if platorm
+    supports them.  In a complex machine certain complex operations may
+    be desired to execute in a thread.  The SilcFSMThread is allocated
+    by silc_fsm_thread_alloc and feed by silc_fsm_free.  It is also
+    possible to use pre-allocated thread by using SilcFSMThreadStruct
+    instead of SilcFSMThread.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSMThreadDestructor.html b/docs/toolkit/manual/silcfsm-SilcFSMThreadDestructor.html new file mode 100644 index 0000000..cddca52 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSMThreadDestructor.html @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcFSMThreadDestructor

    + + +SYNOPSIS + +
    
+    typedef void (*SilcFSMThreadDestructor)(SilcFSMThread thread,
+                                            void *thread_context,
+                                            void *destructor_context);
+
+
    +DESCRIPTION + +
    
+    The destructor callback that was set in silc_fsm_thread_alloc or in
+    silc_fsm_thread_init function.  It will be called when a state function
+    returns SILC_FSM_FINISH.  This function will be called through the
+    scheduler; it will not be called immediately after the state function
+    returns SILC_FSM_FINISH, but will be called later.  The `thread' can
+    be freed in this function.
+
+
    +NOTES + +
    
+    Even if the `thread' was executed in real system thread, this callback
+    is always received in the main machine thread, not in the created
+    thread.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-SilcFSMThreadStruct.html b/docs/toolkit/manual/silcfsm-SilcFSMThreadStruct.html new file mode 100644 index 0000000..dee86c4 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-SilcFSMThreadStruct.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcFSMThreadStruct

    + + +NAME + +
    
+    typedef struct SilcFSMObject SilcFSMThreadStruct;
+
+
    +DESCRIPTION + +
    
+    FSM thread context and can be used as a pre-allocated FSM thread context,
+    instead of SilcFSMThread context.  This context is initialized with the
+    silc_fsm_thread_init function.  It need not be uninitialized.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_alloc.html b/docs/toolkit/manual/silcfsm-silc_fsm_alloc.html new file mode 100644 index 0000000..86b0c9f --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_alloc.html @@ -0,0 +1,283 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_alloc

    + + +SYNOPSIS + +
    
+    SilcFSM silc_fsm_alloc(void *fsm_context,
+                           SilcFSMDestructor destructor,
+                           void *destructor_context,
+                           SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Allocates SILC Finite State Machine context.  The `destructor' with
+    `destructor_context' will be called when the machines finishes.  The
+    caller must free the returned context with silc_fsm_free.  The
+    `fsm_context' is delivered to every FSM state function.  The `schedule'
+    is the caller's scheduler and the FSM will be run in the scheduler.
+
+
    +EXAMPLE + +
    
+    SilcAsyncOperation silc_async_call(Callback callback, void *cb_context)
+    {
+      SilcAsyncOperation op;
+      SilcFSM fsm;
+      ...
+
+      // Allocate async operation so that caller can control us, like abort
+      op = silc_async_alloc(silc_async_call_abort, NULL, ourcontext);
+
+      // Start FSM
+      fsm = silc_fsm_alloc(ourcontext, fsm_destructor, ourcontext,
+                           schedule);
+      silc_fsm_start(fsm, first_state);
+      ...
+
+      // Return async operation for upper layer
+      return op;
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_continue.html b/docs/toolkit/manual/silcfsm-silc_fsm_continue.html new file mode 100644 index 0000000..8e7e9bf --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_continue.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_continue

    + + +SYNOPSIS + +
    
+    void silc_fsm_continue(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Continues in the state machine from a SILC_FSM_WAIT state.  This can
+    be called from outside waiting FSM to continue to the next state.
+    This function can be used instead of SILC_FSM_CALL_CONTINUE macro
+    in case the SILC_FSM_CALL was not used.  This must not be used if
+    SILC_FSM_CALL was used.  This function is used with both SilcFSM and
+    SilcFSMThread contexts.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_continue_sync.html b/docs/toolkit/manual/silcfsm-silc_fsm_continue_sync.html new file mode 100644 index 0000000..324c9c7 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_continue_sync.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_continue_sync

    + + +SYNOPSIS + +
    
+    void silc_fsm_continue_sync(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Continues immediately in the state machine from a SILC_FSM_WAIT state.
+    This can be called from outside waiting FSM to immediately continue to
+    the next state.  This function can be used instead of the
+    SILC_FSM_CALL_CONTINUE_SYNC macro in case the SILC_FSM_CALL was not used.
+    This must not be used if SILC_FSM_CALL was used.  This function is used
+    with both SilcFSM and SilcFSMThread contexts.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_event_alloc.html b/docs/toolkit/manual/silcfsm-silc_fsm_event_alloc.html new file mode 100644 index 0000000..8ef54e2 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_event_alloc.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_event_alloc

    + + +SYNOPSIS + +
    
+    SilcFSMEvent silc_fsm_event_alloc(SilcFSM fsm);
+
+
    +DESCRIPTION + +
    
+    Allocates asynchronous FSM event.  FSM events are asynchronous events
+    that can be waited and signalled.  They can be used as condition
+    variables and signallers.  They can be used for example to wait that
+    some event happens, some thread moves to a specific state or similar.
+    The FSM Events may also be used in FSM threads that are executed in
+    real system threads.  It is safe to wait and signal the event from
+    threads.
+
+    Use the macros SILC_FSM_EVENT_WAIT and SILC_FSM_EVENT_TIMEDWAIT to wait
+    for the event.  Use the SILC_FSM_EVENT_SIGNAL macro to signal all the
+    waiters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_event_free.html b/docs/toolkit/manual/silcfsm-silc_fsm_event_free.html new file mode 100644 index 0000000..b5774a8 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_event_free.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_event_free

    + + +SYNOPSIS + +
    
+    void silc_fsm_event_free(SilcFSMEvent event);
+
+
    +DESCRIPTION + +
    
+    Free the event allocated by silc_fsm_event_alloc function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_event_init.html b/docs/toolkit/manual/silcfsm-silc_fsm_event_init.html new file mode 100644 index 0000000..05e5a26 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_event_init.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_event_init

    + + +SYNOPSIS + +
    
+    void silc_fsm_event_init(SilcFSMEvent event, SilcFSM fsm);
+
+
    +DESCRIPTION + +
    
+    Initializes a pre-allocates FSM event context.  This call is
+    equivalent to silc_fsm_event_alloc except this use the pre-allocated
+    context.  This fuction does not allocate any memory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_finish.html b/docs/toolkit/manual/silcfsm-silc_fsm_finish.html new file mode 100644 index 0000000..b29a47f --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_finish.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_finish

    + + +SYNOPSIS + +
    
+    void silc_fsm_finish(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Finishes the `fsm'.  This function may be used in case the FSM
+    needs to be finished outside FSM states.  Usually FSM is finished
+    by returning SILC_FSM_FINISH from the state, but if this is not
+    possible this function may be called.  This function is used with
+    both SilcFSM and SilcFSMThread contexts.
+
+    If the `fsm' is a machine and it has running threads, the machine
+    will fatally fail.  The caller must first finish the threads and
+    then the machine.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_free.html b/docs/toolkit/manual/silcfsm-silc_fsm_free.html new file mode 100644 index 0000000..7f0b872 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_free.html @@ -0,0 +1,262 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_free

    + + +SYNOPSIS + +
    
+    void silc_fsm_free(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Free the SILC FSM context that was allocated with silc_fsm_alloc,
+    or free the SILC FSM thread context that was allocated with
+    silc_fsm_thread_alloc.  This function is used with both SilcFSM
+    and SilcFSMThread contexts.
+
+
    +NOTES + +
    
+    When freeing FSM, it must not have any active threads.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_get_context.html b/docs/toolkit/manual/silcfsm-silc_fsm_get_context.html new file mode 100644 index 0000000..56e6594 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_get_context.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_get_context

    + + +SYNOPSIS + +
    
+    void *silc_fsm_get_context(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Returns the context associated with the `fsm'.  It is the context that
+    was given to silc_fsm_alloc, silc_fsm_init, silc_fsm_thread_alloc or
+    silc_fsm_thread_init.  This function is used with both SilcFSM and
+    SilcFSMThread contexts.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_get_machine.html b/docs/toolkit/manual/silcfsm-silc_fsm_get_machine.html new file mode 100644 index 0000000..284b9b9 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_get_machine.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_get_machine

    + + +SYNOPSIS + +
    
+    SilcFSM silc_fsm_get_machine(SilcFSMThread thread);
+
+
    +DESCRIPTION + +
    
+    Returns the machine from the FSM thread indicated by `thread'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_get_schedule.html b/docs/toolkit/manual/silcfsm-silc_fsm_get_schedule.html new file mode 100644 index 0000000..c8a0ea1 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_get_schedule.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_get_schedule

    + + +SYNOPSIS + +
    
+    SilcSchedule silc_fsm_get_schedule(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Returns the SilcSchedule that has been associated with the `fsm'.
+    If caller needs scheduler it may retrieve it with this function.  This
+    function is used with both SilcFSM and SilcFSMThread contexts.
+
+    If the `fsm' is thread and real system threads are being used, and this
+    is called from the thread, it will return the SilcSchedule that was
+    allocated by the FSM for the thread.  It is strongly recommended to
+    use this SilcSchedule if you are using real threads, and you need
+    scheduler in the thread.  Note that, once the thread finishes the
+    returned SilcSchedule becomes invalid.
+
+    In other times this returns the SilcSchedule pointer that was given
+    to silc_fsm_alloc or silc_fsm_init.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_get_state_context.html b/docs/toolkit/manual/silcfsm-silc_fsm_get_state_context.html new file mode 100644 index 0000000..517f77f --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_get_state_context.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_get_state_context

    + + +SYNOPSIS + +
    
+    void *silc_fsm_get_state_context(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Returns the state context associated with the `fsm'.  It is the context
+    that was set with silc_fsm_set_state_context function.  This function
+    is used with both SilcFSM and SilcFSMThread contexts.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_init.html b/docs/toolkit/manual/silcfsm-silc_fsm_init.html new file mode 100644 index 0000000..b243a50 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_init.html @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_init

    + + +SYNOPSIS + +
    
+    SilcBool silc_fsm_init(SilcFSM fsm,
+                           void *fsm_context,
+                           SilcFSMDestructor destructor,
+                           void *destructor_context,
+                           SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Initializes a pre-allocated SilcFSM context.  This call is equivalent
+    to silc_fsm_alloc except that this takes the pre-allocated context
+    as argument.  The silc_fsm_free must not be called if this was called.
+    Returns TRUE if the initialization is Ok or FALSE if error occurred.
+    This function does not allocate any memory.  The `schedule' is the
+    caller's scheduler and the FSM will be run in the scheduler.
+
+
    +EXAMPLE + +
    
+    SilcFSMStruct fsm;
+
+    silc_fsm_init(&fsm, application, fsm_destructor, application, schedule);
+    silc_fsm_start(&fsm, first_state);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_is_started.html b/docs/toolkit/manual/silcfsm-silc_fsm_is_started.html new file mode 100644 index 0000000..c9da634 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_is_started.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_is_started

    + + +SYNOPSIS + +
    
+    SilcBool silc_fsm_is_started(void *fsm);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the machine or thread `fsm' has been started and has
+    not been finished yet.  This function is used with both SilcFSM and
+    SilcFSMThread contexts.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_next.html b/docs/toolkit/manual/silcfsm-silc_fsm_next.html new file mode 100644 index 0000000..4eae8cc --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_next.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_next

    + + +SYNOPSIS + +
    
+    void silc_fsm_next(void *fsm, SilcFSMStateCallback next_state);
+
+
    +DESCRIPTION + +
    
+    Set the next state to be executed.  If the state function that
+    call this function returns SILC_FSM_CONTINUE, the `next_state'
+    will be executed immediately.  If it returns SILC_FSM_YIELD it
+    yields the thread and the `next_state' will be run after other
+    threads have run first.  This function must always be used to set
+    the next state in the machine or thread.  This function is used
+    with both SilcFSM and SilcFSMThread contexts.
+
+
    +EXAMPLE + +
    
+    // Move to next state
+    silc_fsm_next(fsm, next_state);
+    return SILC_FSM_CONTINUE;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_next_later.html b/docs/toolkit/manual/silcfsm-silc_fsm_next_later.html new file mode 100644 index 0000000..601d14b --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_next_later.html @@ -0,0 +1,278 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_next_later

    + + +SYNOPSIS + +
    
+    void silc_fsm_next_later(void *fsm, SilcFSMStateCallback next_state,
+                             SilcUInt32 seconds, SilcUInt32 useconds);
+
+
    +DESCRIPTION + +
    
+    Set the next state to be executed later, at the specified time.
+    The SILC_FSM_WAIT must be returned in the state function if this
+    function is called.  If any other state is returned machine operation
+    is undefined.  The machine or thread will move to `next_state' after
+    the specified timeout.  This function is used with both SilcFSM and
+    SilcFSMThread contexts.
+
+
    +NOTES + +
    
+    If both `seconds' and `useconds' are 0, the effect is same as calling
+    silc_fsm_next function, and SILC_FSM_CONTINUE must be returned.
+
+    If silc_fsm_continue or silc_fsm_continue_sync is called while the
+    machine or thread is in SILC_FSM_WAIT state the timeout is automatically
+    canceled and the state moves to the next state.
+
+
    +EXAMPLE + +
    
+    // Move to next state after 10 seconds
+    silc_fsm_next_later(fsm, next_state, 10, 0);
+    return SILC_FSM_WAIT;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_set_context.html b/docs/toolkit/manual/silcfsm-silc_fsm_set_context.html new file mode 100644 index 0000000..6f5f521 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_set_context.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_set_context

    + + +SYNOPSIS + +
    
+    void silc_fsm_set_context(void *fsm, void *fsm_context);
+
+
    +DESCRIPTION + +
    
+    Set new context for the `fsm'.  This function can be used to change
+    the context inside the `fsm', if needed.  This function is used with
+    both SilcFSM and SilcFSMThread contexts.  The context is the
+    `fsm_context' in the state function (SILC_FSM_STATE).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_set_state_context.html b/docs/toolkit/manual/silcfsm-silc_fsm_set_state_context.html new file mode 100644 index 0000000..162927d --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_set_state_context.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_set_state_context

    + + +SYNOPSIS + +
    
+    void silc_fsm_set_state_context(void *fsm, void *state_context);
+
+
    +DESCRIPTION + +
    
+    Set's a state specific context for the `fsm'.  This function can be
+    used to change the state context inside the `fsm', if needed.  This
+    function is used with both SilcFSM and SilcFSMThread contexts.  The
+    context is the `state_context' in the state function (SILC_FSM_STATE).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_start.html b/docs/toolkit/manual/silcfsm-silc_fsm_start.html new file mode 100644 index 0000000..5b3f6a3 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_start.html @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_start

    + + +SYNOPSIS + +
    
+    void silc_fsm_start(void *fsm, SilcFSMStateCallback start_state);
+
+
    +DESCRIPTION + +
    
+    This function must be called after the SILC FSM context was created.
+    This actually starts the state machine.  Note that, the machine is
+    started later after this function returns.  The `start_state' is the
+    state where the machine or thread is started.  This function is used
+    with both SilcFSM and SilcFSMThread contexts.
+
+
    +EXAMPLE + +
    
+    SilcFSM fsm;
+
+    fsm = silc_fsm_alloc(context, destructor, context, schedule);
+    silc_fsm_start(fsm, first_state);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_start_sync.html b/docs/toolkit/manual/silcfsm-silc_fsm_start_sync.html new file mode 100644 index 0000000..52a0b4b --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_start_sync.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_start_sync

    + + +SYNOPSIS + +
    
+    void silc_fsm_start_sync(void *fsm, SilcFSMStateCallback start_state);
+
+
    +DESCRIPTION + +
    
+    This function is same as silc_fsm_start, except that the FSM will
+    be started immediately inside this function.  After this function
+    returns the `start_state' has already been executed.  If the machine
+    is completely synchronous (no waiting used in the machine) then
+    the machine will have finished once this function returns.  Also
+    note that if the machine is completely synchronous the destructor
+    will also be called from inside this function.  This function is used
+    with both SilcFSM and SilcFSMThread contexts.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_thread_alloc.html b/docs/toolkit/manual/silcfsm-silc_fsm_thread_alloc.html new file mode 100644 index 0000000..9a46f06 --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_thread_alloc.html @@ -0,0 +1,299 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_thread_alloc

    + + +SYNOPSIS + +
    
+    SilcFSMThread silc_fsm_thread_alloc(SilcFSM fsm,
+                                        void *thread_context,
+                                        SilcFSMThreadDestructor destructor,
+                                        void *destructor_context,
+                                        SilcBool real_thread);
+
+
    +DESCRIPTION + +
    
+    Allocates FSM thread context.  The thread will be executed in the
+    FSM machine indicated by `fsm'.  The caller must free the returned
+    thread context with silc_fsm_free.  If the 'real_thread' is TRUE
+    then the thread will actually be executed in real thread, if platform
+    supports them.  The `thread_context' is delivered to every state
+    function in the thread.
+
+
    +NOTES + +
    
+    If the system does not support threads, then this function will revert
+    back to normal FSM threads.
+
+    If the `real_thread' is TRUE then FSM will allocate new SilcSchedule
+    for the FSM thread. If you need scheduler in the real thread it is
+    strongly recommended that you use the SilcSchedule that is allocated
+    for the thread.  You can retrieve the SilcSchedule from the thread
+    using silc_fsm_get_schedule function.  Note that, the allocated
+    SilcSchedule will become invalid after the thread finishes.
+
+    If `real_thread' is FALSE the silc_fsm_get_schedule will return
+    the SilcSchedule that was originally given to silc_fsm_alloc or
+    silc_fsm_init.
+
+
    +EXAMPLE + +
    
+    SILC_FSM_STATE(silc_foo_state)
+    {
+      SilcFSMThread thread;
+      ...
+
+      // Execute the route lookup in thread
+      thread = silc_fsm_thread_alloc(fsm, fsm_context, NULL, NULL, FALSE);
+      silc_fsm_start(thread, silc_route_lookup_start);
+
+      // Wait here for the thread to terminate. Set the state where to go
+      // after the thread has terminated.
+      silc_fsm_next(fsm, silc_foo_route_lookup_finished);
+      SILC_FSM_THREAD_WAIT(thread);
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm-silc_fsm_thread_init.html b/docs/toolkit/manual/silcfsm-silc_fsm_thread_init.html new file mode 100644 index 0000000..69902bf --- /dev/null +++ b/docs/toolkit/manual/silcfsm-silc_fsm_thread_init.html @@ -0,0 +1,278 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fsm_thread_init

    + + +SYNOPSIS + +
    
+    void silc_fsm_thread_init(SilcFSMThread thread,
+                              SilcFSM fsm,
+                              void *thread_context,
+                              SilcFSMThreadDestructor destructor,
+                              void *destructor_context,
+                              SilcBool real_thread);
+
+
    +DESCRIPTION + +
    
+    Initializes a pre-allocated SilcFSMThread context.  This call is
+    equivalent to silc_fsm_thread_alloc except that this takes the
+    pre-allocated context as argument.  The silc_fsm_free must not be
+    called if this was called.  If the `real_thread' is TRUE then the
+    thread will actually be executed in real thread, if platform supports
+    them.
+
+
    +NOTES + +
    
+    See the notes from the silc_fsm_thread_alloc.
+
+
    +EXAMPLE + +
    
+    SilcFSMThreadStruct thread;
+
+    silc_fsm_thread_init(&thread, fsm, application, NULL, NULL, FALSE);
+    silc_fsm_start(&thread, first_state);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Finite State Machine
    +SilcFSM
    +SilcFSMStruct
    +SilcFSMThread
    +SilcFSMThreadStruct
    +SILC_FSM_CONTINUE
    +SILC_FSM_YIELD
    +SILC_FSM_WAIT
    +SILC_FSM_FINISH
    +SilcFSMDestructor
    +SilcFSMThreadDestructor
    +SILC_FSM_STATE
    +SILC_FSM_CALL
    +SILC_FSM_CALL_CONTINUE
    +SILC_FSM_CALL_CONTINUE_SYNC
    +SILC_FSM_THREAD_WAIT
    +silc_fsm_alloc
    +silc_fsm_init
    +silc_fsm_thread_alloc
    +silc_fsm_thread_init
    +silc_fsm_free
    +silc_fsm_start
    +silc_fsm_start_sync
    +silc_fsm_next
    +silc_fsm_next_later
    +silc_fsm_continue
    +silc_fsm_continue_sync
    +silc_fsm_finish
    +silc_fsm_set_context
    +silc_fsm_get_context
    +silc_fsm_set_state_context
    +silc_fsm_get_state_context
    +silc_fsm_get_schedule
    +silc_fsm_get_machine
    +silc_fsm_is_started
    +SilcFSMEvent
    +SilcFSMEventStruct
    +silc_fsm_event_alloc
    +silc_fsm_event_init
    +silc_fsm_event_free
    +SILC_FSM_EVENT_WAIT
    +SILC_FSM_EVENT_TIMEDWAIT
    +SILC_FSM_EVENT_SIGNAL
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm.html b/docs/toolkit/manual/silcfsm.html new file mode 100644 index 0000000..df18f78 --- /dev/null +++ b/docs/toolkit/manual/silcfsm.html @@ -0,0 +1,270 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcfsm.html + + + + +
    + +SILC Finite State Machine
    Header: silcfsm.h

    + + +DESCRIPTION + +
    
+ SILC FSM Interface implements a finite state machine.  The FSM can be
+ used to implement all kinds of machines and protocols.  The FSM supports
+ also threads and can be synchronized by using mutex locks.  The FSM
+ also supports real system threads.  It is possible to create new FSM
+ thread and then execute in real system thread, if platform supports
+ threads.
+
+ The FSM provides also asynchronous events that can be used to wait for
+ some events or states to occur.  The FSM events may be used as condition
+ variables and signallers.  The FSM events can safely be used in FSM
+ threads that are executed in real system threads.
+
+ To synchronize machines that use FSM threads that are executed in real
+ system threads the SILC Mutex API (silcmutex.h) may be used.  Normal
+ multi-threaded coding conventions apply when programming with real FSM
+ threads.  If the FSM threads are not real system threads, synchronization
+ is not required.
+
+
  • SilcFSM +
  • SilcFSMStruct +
  • SilcFSMThread +
  • SilcFSMThreadStruct +
  • SILC_FSM_CONTINUE +
  • SILC_FSM_YIELD +
  • SILC_FSM_WAIT +
  • SILC_FSM_FINISH +
  • SilcFSMDestructor +
  • SilcFSMThreadDestructor +
  • SILC_FSM_STATE +
  • SILC_FSM_CALL +
  • SILC_FSM_CALL_CONTINUE +
  • SILC_FSM_CALL_CONTINUE_SYNC +
  • SILC_FSM_THREAD_WAIT +
  • silc_fsm_alloc +
  • silc_fsm_init +
  • silc_fsm_thread_alloc +
  • silc_fsm_thread_init +
  • silc_fsm_free +
  • silc_fsm_start +
  • silc_fsm_start_sync +
  • silc_fsm_next +
  • silc_fsm_next_later +
  • silc_fsm_continue +
  • silc_fsm_continue_sync +
  • silc_fsm_finish +
  • silc_fsm_set_context +
  • silc_fsm_get_context +
  • silc_fsm_set_state_context +
  • silc_fsm_get_state_context +
  • silc_fsm_get_schedule +
  • silc_fsm_get_machine +
  • silc_fsm_is_started +
  • SilcFSMEvent +
  • SilcFSMEventStruct +
  • silc_fsm_event_alloc +
  • silc_fsm_event_init +
  • silc_fsm_event_free +
  • SILC_FSM_EVENT_WAIT +
  • SILC_FSM_EVENT_TIMEDWAIT +
  • SILC_FSM_EVENT_SIGNAL + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm.xref b/docs/toolkit/manual/silcfsm.xref new file mode 100644 index 0000000..e343f1e --- /dev/null +++ b/docs/toolkit/manual/silcfsm.xref @@ -0,0 +1,49 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcfsm.h" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 0 + "SILC Finite State Machine" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 1 + "SilcFSM" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 5 + "SilcFSMStruct" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 5 + "SilcFSMThread" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 5 + "SilcFSMThreadStruct" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 5 + "SILC_FSM_CONTINUE" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_YIELD" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_WAIT" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_FINISH" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SilcFSMDestructor" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "SilcFSMThreadDestructor" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "SILC_FSM_STATE" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_CALL" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_CALL_CONTINUE" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_CALL_CONTINUE_SYNC" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_THREAD_WAIT" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "silc_fsm_alloc" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_init" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_thread_alloc" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_thread_init" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_free" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_start" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_start_sync" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_next" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_next_later" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_continue" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_continue_sync" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_finish" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_set_context" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_get_context" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_set_state_context" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_get_state_context" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_get_schedule" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_get_machine" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_is_started" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "SilcFSMEvent" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 5 + "SilcFSMEventStruct" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 5 + "silc_fsm_event_alloc" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_event_init" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "silc_fsm_event_free" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + "SILC_FSM_EVENT_WAIT" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_EVENT_TIMEDWAIT" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 8 + "SILC_FSM_EVENT_SIGNAL" "/home/priikone/silc1/doc/toolkit/silcfsm.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcfsm_i.html b/docs/toolkit/manual/silcfsm_i.html new file mode 100644 index 0000000..3fdcb18 --- /dev/null +++ b/docs/toolkit/manual/silcfsm_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcfsm_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcfsm_i.xref b/docs/toolkit/manual/silcfsm_i.xref new file mode 100644 index 0000000..828e4a5 --- /dev/null +++ b/docs/toolkit/manual/silcfsm_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcfsm_i.h" "/home/priikone/silc1/doc/toolkit/silcfsm_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silchash-SilcHash.html b/docs/toolkit/manual/silchash-SilcHash.html new file mode 100644 index 0000000..ddb5c2b --- /dev/null +++ b/docs/toolkit/manual/silchash-SilcHash.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHash

    + + +NAME + +
    
+    typedef struct SilcHashStruct *SilcHash;
+
+
    +DESCRIPTION + +
    
+    This context is the actual hash function context and is allocated
+    by silc_hash_alloc and given as argument usually to all
+    silc_hash_* functions.  It is freed by the silc_hash_free
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-SilcHashObject.html b/docs/toolkit/manual/silchash-SilcHashObject.html new file mode 100644 index 0000000..5cb9177 --- /dev/null +++ b/docs/toolkit/manual/silchash-SilcHashObject.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHashObject

    + + +NAME + +
    
+    typedef struct { ... } SilcHashObject;
+
+
    +DESCRIPTION + +
    
+    This structure represents one hash function.  The hash function's
+    name, digest length and block length are defined in the structure.
+    This structure is then given as argument to the silc_hash_register.
+    That function is used to register all hash functions into SILC.
+    They can be then allocated by the name found in this structure by
+    calling the silc_hash_alloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_alloc.html b/docs/toolkit/manual/silchash-silc_hash_alloc.html new file mode 100644 index 0000000..78b3c31 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_alloc.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_alloc(const unsigned char *name, SilcHash *new_hash);
+
+
    +DESCRIPTION + +
    
+    Allocates a new SilcHash object of name of `name'.  The new allocated
+    hash function is returned into `new_hash' pointer.  This function
+    returns FALSE if such hash function does not exist.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_alloc_by_oid.html b/docs/toolkit/manual/silchash-silc_hash_alloc_by_oid.html new file mode 100644 index 0000000..0ec7b10 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_alloc_by_oid.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_alloc_by_oid

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_alloc_by_oid(const char *oid, SilcHash *new_hash);
+
+
    +DESCRIPTION + +
    
+    Same as silc_hash_alloc but allocates the hash algorithm by the
+    hash algorithm OID string indicated by `oid'. Returns FALSE if such
+    hash function does not exist.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_babbleprint.html b/docs/toolkit/manual/silchash-silc_hash_babbleprint.html new file mode 100644 index 0000000..7535d58 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_babbleprint.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_babbleprint

    + + +SYNOPSIS + +
    
+    char *silc_hash_babbleprint(SilcHash hash, const unsigned char *data,
+                                SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Utility function which can be used to create a textual babbleprint
+    out of the data indicated by `data' of length of `data_len' bytes.
+    If `hash' is NULL then SHA1 hash function is used automatically.
+    The caller must free the returned string.
+
+    The babbleprint is same as fingerprint but encoded in a form which
+    makes it easier to pronounce.  When verifying fingerprint for example
+    over a phone call, the babbleprint makes it easier to read the
+    fingerprint.
+
+    Example output could be:
+      xiber-zulad-vubug-noban-puvyc-labac-zonos-gedik-novem-rudog-tyxix
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_block_len.html b/docs/toolkit/manual/silchash-silc_hash_block_len.html new file mode 100644 index 0000000..0c5f33b --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_block_len.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_block_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_block_len(SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Returns the block length of the hash function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_final.html b/docs/toolkit/manual/silchash-silc_hash_final.html new file mode 100644 index 0000000..518ede2 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_final.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_final

    + + +SYNOPSIS + +
    
+    void silc_hash_final(SilcHash hash, unsigned char *return_hash);
+
+
    +DESCRIPTION + +
    
+    This function is used to produce the final message digest from
+    the data that has been added to the hash function context by calling
+    the silc_hash_update function.  The digest is copied in to the
+    `return_hash' pointer which must be at least the size that
+    the silc_hash_len returns.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_fingerprint.html b/docs/toolkit/manual/silchash-silc_hash_fingerprint.html new file mode 100644 index 0000000..49f40fa --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_fingerprint.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_fingerprint

    + + +SYNOPSIS + +
    
+    char *silc_hash_fingerprint(SilcHash hash, const unsigned char *data,
+                                SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Utility function which can be used to create a textual fingerprint
+    out of the data indicated by `data' of length of `data_len' bytes.
+    If `hash' is NULL then SHA1 hash function is used automatically.
+    The caller must free the returned string.
+
+    Example output could be:
+      41BF 5C2E 4149 039A 3917  831F 65C4 0A69 F98B 0A4D
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_free.html b/docs/toolkit/manual/silchash-silc_hash_free.html new file mode 100644 index 0000000..0163298 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_free.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_free

    + + +SYNOPSIS + +
    
+    void silc_hash_free(SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Frees the allocated hash function context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_get_name.html b/docs/toolkit/manual/silchash-silc_hash_get_name.html new file mode 100644 index 0000000..30f44bd --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_get_name.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_get_name

    + + +SYNOPSIS + +
    
+    const char *silc_hash_get_name(SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Returns the name of the hash function indicated by the `hash' context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_get_oid.html b/docs/toolkit/manual/silchash-silc_hash_get_oid.html new file mode 100644 index 0000000..8930b56 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_get_oid.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_get_oid

    + + +SYNOPSIS + +
    
+    const char *silc_hash_get_name(SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Returns the hash OID string.  Returns NULL if the hash doesn't have
+    OID string.  Use strlen() to get the OID string length.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_get_supported.html b/docs/toolkit/manual/silchash-silc_hash_get_supported.html new file mode 100644 index 0000000..ede04df --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_get_supported.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_get_supported

    + + +SYNOPSIS + +
    
+    char *silc_hash_get_supported(void);
+
+
    +DESCRIPTION + +
    
+    Returns comma (`,') separated list of registered hash functions  This
+    is used for example when sending supported hash function list during
+    the SILC Key Exchange protocol (SKE).  The caller must free the returned
+    pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_init.html b/docs/toolkit/manual/silchash-silc_hash_init.html new file mode 100644 index 0000000..6d30756 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_init.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_init

    + + +SYNOPSIS + +
    
+    void silc_hash_init(SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Sometimes calling the silc_hash_make might not be the most optimal
+    case of computing digests.  If you have a lot of different data
+    that you need to put together for computing a digest you may either
+    put them into a buffer and compute the digest from the buffer by
+    calling the silc_hash_make, or you can use the silc_hash_init,
+    silc_hash_update and silc_hash_final to do the digest.  This function
+    prepares the allocated hash function context for this kind of digest
+    computation.  To add the data to be used in the digest computation
+    call the silc_hash_update function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_is_supported.html b/docs/toolkit/manual/silchash-silc_hash_is_supported.html new file mode 100644 index 0000000..299dbfa --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_is_supported.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_is_supported

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_is_supported(const unsigned char *name);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the hash function indicated by the `name' exists.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_len.html b/docs/toolkit/manual/silchash-silc_hash_len.html new file mode 100644 index 0000000..507cd37 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_len.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_len(SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Returns the length of the message digest the hash function produce.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_make.html b/docs/toolkit/manual/silchash-silc_hash_make.html new file mode 100644 index 0000000..a94f564 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_make.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_make

    + + +SYNOPSIS + +
    
+    void silc_hash_make(SilcHash hash, const unsigned char *data,
+                        SilcUInt32 len, unsigned char *return_hash);
+
+
    +DESCRIPTION + +
    
+    Computes the message digest (hash) out of the data indicated by
+    `data' of length of `len' bytes.  Returns the message digest to the
+    `return_hash' buffer which must be at least of the size of the
+    message digest the `hash' produces.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_register.html b/docs/toolkit/manual/silchash-silc_hash_register.html new file mode 100644 index 0000000..9e82e2c --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_register.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_register

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_register(const SilcHashObject *hash);
+
+
    +DESCRIPTION + +
    
+    Registers a new hash function into the SILC.  This function is used
+    at the initialization of the SILC.  All registered hash functions
+    should be unregistered with silc_hash_unregister.  The `hash' includes
+    the name of the hash function, digest length and block length.  Usually
+    this function is not called directly.  Instead, application can call
+    the silc_hash_register_default to register all default hash functions
+    that are builtin the sources.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_register_default.html b/docs/toolkit/manual/silchash-silc_hash_register_default.html new file mode 100644 index 0000000..24cb896 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_register_default.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_register_default

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_register_default(void);
+
+
    +DESCRIPTION + +
    
+    Registers all default hash functions into the SILC.  These are the
+    hash functions that are builtin in the sources.  See the list of
+    default hash functions in the silchash.c source file.  The application
+    may use this to register default hash functions if specific hash
+    function in any specific order is not wanted (application's
+    configuration usually may decide the order of the registration, in
+    which case this function should not be used).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_transform.html b/docs/toolkit/manual/silchash-silc_hash_transform.html new file mode 100644 index 0000000..76441c8 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_transform.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_transform

    + + +SYNOPSIS + +
    
+    void silc_hash_transform(SilcHash hash, SilcUInt32 *state,
+                             const unsigned char *data);
+
+
    +DESCRIPTION + +
    
+    This is special function for calling the hash function's internal
+    digest generation function.  The size of the `state' array and the
+    sizeof the `data' buffer is hash function specific and must be
+    known by the caller.  Usually this function is not needed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_unregister.html b/docs/toolkit/manual/silchash-silc_hash_unregister.html new file mode 100644 index 0000000..9a45b0e --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_unregister.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_unregister

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_unregister(SilcHashObject *hash);
+
+
    +DESCRIPTION + +
    
+    Unregister a hash function from SILC by the SilcHashObject `hash'.
+    This should be called for all registered hash functions.  Returns
+    FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_unregister_all.html b/docs/toolkit/manual/silchash-silc_hash_unregister_all.html new file mode 100644 index 0000000..8aaeef3 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_unregister_all.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_unregister_all

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_unregister_all(void);
+
+
    +DESCRIPTION + +
    
+    Unregisters all registered hash functions.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash-silc_hash_update.html b/docs/toolkit/manual/silchash-silc_hash_update.html new file mode 100644 index 0000000..3fb36c7 --- /dev/null +++ b/docs/toolkit/manual/silchash-silc_hash_update.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_update

    + + +SYNOPSIS + +
    
+    void silc_hash_update(SilcHash hash, const unsigned char *data,
+                          SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    This function may be called to add data to be used in the digest
+    computation.  This can be called multiple times to add data from
+    many sources before actually computing the digest.  Once you've
+    added all the data you need you can call the silc_hash_final to
+    actually produce the message digest value.
+
+
    +EXAMPLE + +
    
+    unsigned char digest[20];
+
+    silc_hash_init(hash);
+    silc_hash_update(hash, data, data_len);
+    silc_hash_update(hash, more_data, more_data_len);
+    silc_hash_final(hash, digest);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Interface
    +SilcHash
    +SilcHashObject
    +silc_hash_register
    +silc_hash_unregister
    +silc_hash_register_default
    +silc_hash_unregister_all
    +silc_hash_alloc
    +silc_hash_alloc_by_oid
    +silc_hash_free
    +silc_hash_is_supported
    +silc_hash_get_supported
    +silc_hash_len
    +silc_hash_block_len
    +silc_hash_get_name
    +silc_hash_get_oid
    +silc_hash_make
    +silc_hash_init
    +silc_hash_update
    +silc_hash_final
    +silc_hash_transform
    +silc_hash_fingerprint
    +silc_hash_babbleprint
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash.html b/docs/toolkit/manual/silchash.html new file mode 100644 index 0000000..00fc76d --- /dev/null +++ b/docs/toolkit/manual/silchash.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silchash.html + + + + +
    + +SILC Hash Interface
    Header: silchash.h

    + + +DESCRIPTION + +
    
+    This is the interface for hash functions which are used to create
+    message digests.  The routines are used in various cryptographic
+    operations.  SILC Hash Interface is used for example by the
+    SILC HMAC Interface (SilcHmac).
+
+
  • SilcHash +
  • SilcHashObject +
  • silc_hash_register +
  • silc_hash_unregister +
  • silc_hash_register_default +
  • silc_hash_unregister_all +
  • silc_hash_alloc +
  • silc_hash_alloc_by_oid +
  • silc_hash_free +
  • silc_hash_is_supported +
  • silc_hash_get_supported +
  • silc_hash_len +
  • silc_hash_block_len +
  • silc_hash_get_name +
  • silc_hash_get_oid +
  • silc_hash_make +
  • silc_hash_init +
  • silc_hash_update +
  • silc_hash_final +
  • silc_hash_transform +
  • silc_hash_fingerprint +
  • silc_hash_babbleprint + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchash.xref b/docs/toolkit/manual/silchash.xref new file mode 100644 index 0000000..b52303f --- /dev/null +++ b/docs/toolkit/manual/silchash.xref @@ -0,0 +1,29 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silchash.h" "/home/priikone/silc1/doc/toolkit/silchash.html" 0 + "SILC Hash Interface" "/home/priikone/silc1/doc/toolkit/silchash.html" 1 + "SilcHash" "/home/priikone/silc1/doc/toolkit/silchash.html" 5 + "SilcHashObject" "/home/priikone/silc1/doc/toolkit/silchash.html" 5 + "silc_hash_register" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_unregister" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_register_default" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_unregister_all" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_alloc" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_alloc_by_oid" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_free" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_is_supported" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_get_supported" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_len" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_block_len" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_get_name" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_get_oid" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_make" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_init" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_update" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_final" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_transform" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_fingerprint" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + "silc_hash_babbleprint" "/home/priikone/silc1/doc/toolkit/silchash.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silchashtable-SilcHashCompare.html b/docs/toolkit/manual/silchashtable-SilcHashCompare.html new file mode 100644 index 0000000..a20fbb0 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-SilcHashCompare.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcHashCompare

    + + +SYNOPSIS + +
    
+    typedef SilcBool (*SilcHashCompare)(void *key1, void *key2,
+                                        void *user_context);
+
+
    +DESCRIPTION + +
    
+    A comparison funtion that is called to compare the two keys `key1' and
+    `key2'. If they are equal this must return TRUE or FALSE otherwise.
+    The application provides this function when allocating a new hash table.
+    The `user_context' is application specific context and is delivered
+    to the callback.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-SilcHashDestructor.html b/docs/toolkit/manual/silchashtable-SilcHashDestructor.html new file mode 100644 index 0000000..219b16e --- /dev/null +++ b/docs/toolkit/manual/silchashtable-SilcHashDestructor.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcHashDestructor

    + + +SYNOPSIS + +
    
+    typedef void (*SilcHashDestructor)(void *key, void *context,
+                                       void *user_context);
+
+
    +DESCRIPTION + +
    
+    A destructor callback that the library will call to destroy the
+    `key' and `context'.  The application provides the function when
+    allocating a new hash table. The `user_context' is application
+    specific context and is delivered to the callback.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-SilcHashForeach.html b/docs/toolkit/manual/silchashtable-SilcHashForeach.html new file mode 100644 index 0000000..8f71734 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-SilcHashForeach.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcHashForeach

    + + +SYNOPSIS + +
    
+    typedef void (*SilcHashForeach)(void *key, void *context,
+                                    void *user_context);
+
+
    +DESCRIPTION + +
    
+    Foreach function. This is called when traversing the entrys in the
+    hash table using silc_hash_table_foreach. The `user_context' is
+    application specific context and is delivered to the callback.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-SilcHashFunction.html b/docs/toolkit/manual/silchashtable-SilcHashFunction.html new file mode 100644 index 0000000..62c789f --- /dev/null +++ b/docs/toolkit/manual/silchashtable-SilcHashFunction.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcHashFunction

    + + +SYNOPSIS + +
    
+    typedef SilcUInt32 (*SilcHashFunction)(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    A type for the hash function. This function is used to hash the
+    provided key value `key' and return the index for the hash table.
+    The `user_context' is application specific context and is delivered
+    to the callback.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-SilcHashTable.html b/docs/toolkit/manual/silchashtable-SilcHashTable.html new file mode 100644 index 0000000..8277b8e --- /dev/null +++ b/docs/toolkit/manual/silchashtable-SilcHashTable.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHashTable

    + + +NAME + +
    
+    typedef struct SilcHashTableStruct *SilcHashTable;
+
+
    +DESCRIPTION + +
    
+    This context is the actual hash table and is allocated
+    by silc_hash_table_alloc and given as argument usually to
+    all silc_hash_table_* functions.  It is freed by the
+    silc_hash_table_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-SilcHashTableList.html b/docs/toolkit/manual/silchashtable-SilcHashTableList.html new file mode 100644 index 0000000..f1eaa73 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-SilcHashTableList.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHashTableList

    + + +NAME + +
    
+    typedef struct SilcHashTableListStruct SilcHashTableList;
+
+
    +DESCRIPTION + +
    
+    This structure is used to tarverse the hash table. This structure
+    is given as argument to the silc_hash_table_list function to
+    initialize it and then used to traverse the hash table with the
+    silc_hash_table_get function. It needs not be allocated or freed.
+
+
    +EXAMPLE + +
    
+    SilcHashTableList htl;
+    silc_hash_table_list(hash_table, &htl);
+    while (silc_hash_table_get(&htl, (void *)&key, (void *)&context))
+      ...
+    silc_hash_table_list_reset(&htl);
+
+
    +SOURCE + +
        typedef struct SilcHashTableListStruct SilcHashTableList;
+    
+    /* List structure to traverse the hash table. */
+    struct SilcHashTableListStruct {
+      SilcHashTable ht;
+      void *entry;
+      unsigned int index        : 31;
+      unsigned int auto_rehash  : 1;
+    };
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_add.html b/docs/toolkit/manual/silchashtable-silc_hash_table_add.html new file mode 100644 index 0000000..de892c9 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_add.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_add

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_add(SilcHashTable ht, void *key, void *context);
+
+
    +DESCRIPTION + +
    
+    Adds new entry to the hash table. The `key' is hashed using the
+    hash function and the both `key' and `context' will be saved to the
+    hash table. This function quarantees that the entry is always added
+    to the hash table reliably (it is collision resistant).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_add_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_add_ext.html new file mode 100644 index 0000000..840d040 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_add_ext.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_add_ext

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_add_ext(SilcHashTable ht, void *key,
+                                     void *context,
+                                     SilcHashFunction hash,
+                                     void *hash_user_context);
+
+
    +DESCRIPTION + +
    
+    Adds new entry to the hash table. The `key' is hashed using the
+    hash function and the both `key' and `context' will be saved to the
+    hash table. This function quarantees that the entry is always added
+    to the hash table reliably (it is collision resistant).
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_alloc.html b/docs/toolkit/manual/silchashtable-silc_hash_table_alloc.html new file mode 100644 index 0000000..7ecd3b1 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_alloc.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_alloc

    + + +SYNOPSIS + +
    
+    SilcHashTable silc_hash_table_alloc(SilcUInt32 table_size,
+                                        SilcHashFunction hash,
+                                        void *hash_user_context,
+                                        SilcHashCompare compare,
+                                        void *compare_user_context,
+                                        SilcHashDestructor destructor,
+                                        void *destructor_user_context,
+                                        SilcBool auto_rehash);
+
+
    +DESCRIPTION + +
    
+    Allocates new hash table and returns it.  If the `table_size' is not
+    zero then the hash table size is the size provided. If zero then the
+    default size will be used. Note that if the `table_size' is provided
+    it should be a prime. The `hash', `compare' and `destructor' are
+    the hash function, the key comparison function and key and context
+    destructor function, respectively. The `hash' is mandatory, the others
+    are optional.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_count.html b/docs/toolkit/manual/silchashtable-silc_hash_table_count.html new file mode 100644 index 0000000..5fc5be2 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_count.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_count

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_table_count(SilcHashTable ht);
+
+
    +DESCRIPTION + +
    
+    Returns the number of the entires in the hash table. If there is more
+    entries in the table thatn the size of the hash table calling the
+    silc_hash_table_rehash is recommended.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_del.html b/docs/toolkit/manual/silchashtable-silc_hash_table_del.html new file mode 100644 index 0000000..64ef6bf --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_del.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_del

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_del(SilcHashTable ht, void *key);
+
+
    +DESCRIPTION + +
    
+    Removes the entry from the hash table by the provided `key'. This will
+    call the destructor funtion for the found entry. Return TRUE if the
+    entry was removed successfully and FALSE otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context.html b/docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context.html new file mode 100644 index 0000000..3b467f7 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_del_by_context

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_del_by_context(SilcHashTable ht, void *key,
+                                            void *context);
+
+
    +DESCRIPTION + +
    
+    Same as silc_hash_table_del but verifies that the context associated
+    with the `key' matches the `context'. This is handy to use with hash
+    tables that may have duplicate keys. In that case the `context' may
+    be used to check whether the correct entry is being deleted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context_ext.html new file mode 100644 index 0000000..d0966de --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_del_by_context_ext.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_del_by_context_ext

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_hash_table_del_by_context_ext(SilcHashTable ht, void *key,
+                                       void *context,
+                                       SilcHashFunction hash,
+                                       void *hash_user_context,
+                                       SilcHashCompare compare,
+                                       void *compare_user_context,
+                                       SilcHashDestructor destructor,
+                                       void *destructor_user_context);
+
+
    +DESCRIPTION + +
    
+    Same as silc_hash_table_del but verifies that the context associated
+    with the `key' matches the `context'. This is handy to use with hash
+    tables that may have duplicate keys. In that case the `context' may
+    be used to check whether the correct entry is being deleted.
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+    The `compare' and `compare_user_context' are application specified
+    comparing function. If not provided the hash table's default is used.
+    The `destructor' and `destructor_user_context' are application
+    specific destructor function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_del_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_del_ext.html new file mode 100644 index 0000000..aed5a1e --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_del_ext.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_del_ext

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_del_ext(SilcHashTable ht, void *key,
+                                     SilcHashFunction hash,
+                                     void *hash_user_context,
+                                     SilcHashCompare compare,
+                                     void *compare_user_context,
+                                     SilcHashDestructor destructor,
+                                     void *destructor_user_context);
+
+
    +DESCRIPTION + +
    
+    Removes the entry from the hash table by the provided `key'. This will
+    call the destructor funtion for the found entry. Return TRUE if the
+    entry was removed successfully and FALSE otherwise.
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+    The `compare' and `compare_user_context' are application specified
+    comparing function. If not provided the hash table's default is used.
+    The `destructor' and `destructor_user_context' are application
+    specific destructor function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_find.html b/docs/toolkit/manual/silchashtable-silc_hash_table_find.html new file mode 100644 index 0000000..3042e4e --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_find.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_find

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_find(SilcHashTable ht, void *key,
+                                  void **ret_key, void **ret_context);
+
+
    +DESCRIPTION + +
    
+    Finds the entry in the hash table by the provided `key' as fast as
+    possible. Return TRUE if the entry was found and FALSE otherwise.
+    The found entry is returned to the `ret_key' and `ret_context',
+    respectively. If the `ret_key and `ret_context' are NULL then this
+    maybe used only to check whether given key exists in the table.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context.html b/docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context.html new file mode 100644 index 0000000..cf87b29 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_find_by_context

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_find_by_context(SilcHashTable ht, void *key,
+                                             void *context, void **ret_key);
+
+
    +DESCRIPTION + +
    
+    Finds the entry in the hash table by the provided `key' and
+    `context' as fast as possible.  This is handy function when there
+    can be multiple same keys in the hash table.  By using this function
+    the specific key with specific context can be found.  Return
+    TRUE if the entry with the key and context was found and FALSE
+    otherwise.  The function returns only the key to `ret_key' since
+    the caller already knows the context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context_ext.html new file mode 100644 index 0000000..34bc5f2 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_find_by_context_ext.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_find_by_context_ext

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_hash_table_find_by_context_ext(SilcHashTable ht, void *key,
+                                        void *context, void **ret_key,
+                                        SilcHashFunction hash,
+                                        void *hash_user_context,
+                                        SilcHashCompare compare,
+                                        void *compare_user_context);
+
+
    +DESCRIPTION + +
    
+    Finds the entry in the hash table by the provided `key' and
+    `context' as fast as possible.  This is handy function when there
+    can be multiple same keys in the hash table.  By using this function
+    the specific key with specific context can be found.  Return
+    TRUE if the entry with the key and context was found and FALSE
+    otherwise.  The function returns only the key to `ret_key' since
+    the caller already knows the context.
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+    The `compare' and `compare_user_context' are application specified
+    comparing function. If not provided the hash table's default is used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_find_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_find_ext.html new file mode 100644 index 0000000..2fd54ac --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_find_ext.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_find_ext

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_find_ext(SilcHashTable ht, void *key,
+                                      void **ret_key, void **ret_context,
+                                      SilcHashFunction hash,
+                                      void *hash_user_context,
+                                      SilcHashCompare compare,
+                                      void *compare_user_context);
+
+
    +DESCRIPTION + +
    
+    Finds the entry in the hash table by the provided `key' as fast as
+    possible. Return TRUE if the entry was found and FALSE otherwise.
+    The found entry is returned to the `ret_key' and `ret_context',
+    respectively. If the `ret_key and `ret_context' are NULL then this
+    maybe used only to check whether given key exists in the table.
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+    The `compare' and `compare_user_context' are application specified
+    comparing function. If not provided the hash table's default is used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach.html b/docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach.html new file mode 100644 index 0000000..0c1e5ef --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_find_foreach

    + + +SYNOPSIS + +
    
+    void silc_hash_table_find_foreach(SilcHashTable ht, void *key,
+                                      SilcHashForeach foreach,
+                                      void *user_context);
+
+
    +DESCRIPTION + +
    
+    As the hash table is collision resistant it is possible to save duplicate
+    keys to the hash table. This function can be used to find all keys
+    and contexts from the hash table that are found using the `key'. The
+    `foreach' is called for every found key. If no entries can be found
+    the `foreach' will be called once with the context set NULL and
+    `key' and `user_context' sent to the function.
+
+
    +NOTES + +
    
+    The hash table will not be rehashed during the traversing of the table,
+    even if the table was marked as auto rehashable.  The caller also must
+    not call silc_hash_table_rehash while traversing the table.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach_ext.html new file mode 100644 index 0000000..e4ef7cc --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_find_foreach_ext.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_find_foreach_ext

    + + +SYNOPSIS + +
    
+    void silc_hash_table_find_foreach_ext(SilcHashTable ht, void *key,
+                                          SilcHashFunction hash,
+                                          void *hash_user_context,
+                                          SilcHashCompare compare,
+                                          void *compare_user_context,
+                                          SilcHashForeach foreach,
+                                          void *foreach_user_context);
+
+
    +DESCRIPTION + +
    
+    As the hash table is collision resistant it is possible to save duplicate
+    keys to the hash table. This function can be used to find all keys
+    and contexts from the hash table that are found using the `key'. The
+    `foreach' is called for every found key. If no entries can be found
+    the `foreach' will be called once with the context set NULL and
+    `key' and `user_context' sent to the function.
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+    The `compare' and `compare_user_context' are application specified
+    comparing function. If not provided the hash table's default is used.
+
+
    +NOTES + +
    
+    The hash table will not be rehashed during the traversing of the table,
+    even if the table was marked as auto rehashable.  The caller also must
+    not call silc_hash_table_rehash while traversing the table.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_foreach.html b/docs/toolkit/manual/silchashtable-silc_hash_table_foreach.html new file mode 100644 index 0000000..9125bea --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_foreach.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_foreach

    + + +SYNOPSIS + +
    
+    void silc_hash_table_foreach(SilcHashTable ht, SilcHashForeach foreach,
+                                 void *user_context);
+
+
    +DESCRIPTION + +
    
+    Traverse all entrys in the hash table and call the `foreach' for
+    every entry with the `user_context' context.
+
+
    +NOTES + +
    
+    The hash table will not be rehashed during the traversing of the table,
+    even if the table was marked as auto rehashable.  The caller also must
+    not call silc_hash_table_rehash while traversing the table.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_free.html b/docs/toolkit/manual/silchashtable-silc_hash_table_free.html new file mode 100644 index 0000000..0a7c273 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_free.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_free

    + + +SYNOPSIS + +
    
+    void silc_hash_table_free(SilcHashTable ht);
+
+
    +DESCRIPTION + +
    
+    Frees the hash table. The destructor function provided in the
+    silc_hash_table_alloc will be called for all keys in the hash table.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_get.html b/docs/toolkit/manual/silchashtable-silc_hash_table_get.html new file mode 100644 index 0000000..382bc3e --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_get.html @@ -0,0 +1,254 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_get

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_get(SilcHashTableList *htl, void **key,
+                                 void **context);
+
+
    +DESCRIPTION + +
    
+    Returns always the next entry in the hash table into the `key' and
+    `context' and TRUE.  If this returns FALSE then there are no more
+    entries.
+
+
    +EXAMPLE + +
    
+    SilcHashTableList htl;
+    silc_hash_table_list(hash_table, &htl);
+    while (silc_hash_table_get(&htl, (void *)&key, (void *)&context))
+      ...
+    silc_hash_table_list_reset(&htl);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_list.html b/docs/toolkit/manual/silchashtable-silc_hash_table_list.html new file mode 100644 index 0000000..8dd17a7 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_list.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_list

    + + +SYNOPSIS + +
    
+    void silc_hash_table_list(SilcHashTable ht, SilcHashTableList *htl);
+
+
    +DESCRIPTION + +
    
+    Prepares the `htl' SilcHashTableList sent as argument to be used in the
+    hash table traversing with the silc_hash_table_get.  After the hash
+    table traversing is completed the silc_hash_table_list_reset must be
+    called.
+
+
    +NOTES + +
    
+    The hash table will not be rehashed during the traversing of the list,
+    even if the table was marked as auto rehashable.  The caller also must
+    not call silc_hash_table_rehash while traversing the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_list_reset.html b/docs/toolkit/manual/silchashtable-silc_hash_table_list_reset.html new file mode 100644 index 0000000..33cc75d --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_list_reset.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_list_reset

    + + +SYNOPSIS + +
    
+    void silc_hash_table_list_reset(SilcHashTableList *htl);
+
+
    +DESCRIPTION + +
    
+    Resets the `htl' SilcHashTableList.  This must be called after the
+    hash table traversing is completed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_rehash.html b/docs/toolkit/manual/silchashtable-silc_hash_table_rehash.html new file mode 100644 index 0000000..c75c95d --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_rehash.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_rehash

    + + +SYNOPSIS + +
    
+    void silc_hash_table_rehash(SilcHashTable ht, SilcUInt32 new_size);
+
+
    +DESCRIPTION + +
    
+    Rehashs the hash table. The size of the new hash table is provided
+    as `new_size'. If the `new_size' is zero then this routine will make
+    the new table of a suitable size. Note that this operation may be
+    very slow.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_rehash_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_rehash_ext.html new file mode 100644 index 0000000..5ec0e26 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_rehash_ext.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_rehash_ext

    + + +SYNOPSIS + +
    
+    void silc_hash_table_rehash_ext(SilcHashTable ht, SilcUInt32 new_size,
+                                    SilcHashFunction hash,
+                                    void *hash_user_context);
+
+
    +DESCRIPTION + +
    
+    Rehashs the hash table. The size of the new hash table is provided
+    as `new_size'. If the `new_size' is zero then this routine will make
+    the new table of a suitable size. Note that this operation may be
+    very slow.
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_replace.html b/docs/toolkit/manual/silchashtable-silc_hash_table_replace.html new file mode 100644 index 0000000..5e02209 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_replace.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_replace

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_replace(SilcHashTable ht, void *key,
+                                     void *context);
+
+
    +DESCRIPTION + +
    
+    Same as silc_hash_table_add but if the `key' already exists in the
+    hash table the old key and the old context will be replaced with the
+    `key' and the `context. The destructor function will be called for the
+    replaced key and context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_replace_ext.html b/docs/toolkit/manual/silchashtable-silc_hash_table_replace_ext.html new file mode 100644 index 0000000..7bc16a6 --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_replace_ext.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_replace_ext

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_table_replace_ext(SilcHashTable ht, void *key,
+                                         void *context,
+                                         SilcHashFunction hash,
+                                         void *hash_user_context);
+
+
    +DESCRIPTION + +
    
+    Same as silc_hash_table_add_ext but if the `key' already exists in the
+    hash table the old key and the old context will be replaced with the
+    `key' and the `context. The destructor function will be called for the
+    replaced key and context.
+
+    The `hash' and `hash_user_context' are application specified hash
+    function. If not provided the hash table's default is used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable-silc_hash_table_size.html b/docs/toolkit/manual/silchashtable-silc_hash_table_size.html new file mode 100644 index 0000000..f2429ce --- /dev/null +++ b/docs/toolkit/manual/silchashtable-silc_hash_table_size.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_table_size

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_table_size(SilcHashTable ht);
+
+
    +DESCRIPTION + +
    
+    Returns the size of the hash table. This is the true size of the
+    hash table.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Hash Table Interface
    +SilcHashTable
    +SilcHashTableList
    +SilcHashFunction
    +SilcHashCompare
    +SilcHashDestructor
    +SilcHashForeach
    +silc_hash_table_alloc
    +silc_hash_table_free
    +silc_hash_table_size
    +silc_hash_table_count
    +silc_hash_table_add
    +silc_hash_table_replace
    +silc_hash_table_del
    +silc_hash_table_del_by_context
    +silc_hash_table_find
    +silc_hash_table_find_by_context
    +silc_hash_table_find_foreach
    +silc_hash_table_foreach
    +silc_hash_table_rehash
    +silc_hash_table_list
    +silc_hash_table_list_reset
    +silc_hash_table_get
    +silc_hash_table_add_ext
    +silc_hash_table_replace_ext
    +silc_hash_table_del_ext
    +silc_hash_table_del_by_context_ext
    +silc_hash_table_find_ext
    +silc_hash_table_find_by_context_ext
    +silc_hash_table_find_foreach_ext
    +silc_hash_table_rehash_ext
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable.html b/docs/toolkit/manual/silchashtable.html new file mode 100644 index 0000000..6244bb7 --- /dev/null +++ b/docs/toolkit/manual/silchashtable.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silchashtable.html + + + + +
    + +SILC Hash Table Interface
    Header: silchashtable.h

    + + +DESCRIPTION + +
    
+ Implementation of collision resistant hash table. This is a hash table
+ that provides a reliable (what you add there stays there, and duplicate
+ keys are allowed) with as fast reference to the key as possible. If
+ there are a lot of duplicate keys in the hash table the lookup gets
+ slower of course. However, this is reliable and no data is lost at any
+ point. If you know that you never have duplicate keys then this is as
+ fast as any simple hash table.
+
+ The interface provides many ways to search the hash table including
+ an extended interface where caller can specify its own hash and comparison
+ functions.
+
+ There are two ways to traverse the entire hash table if this feature
+ is needed. There exists a foreach function that calls a foreach
+ callback for each entry in the hash table. Other way is to use
+ SilcHashTableList structure and traverse the hash table inside while()
+ using the list structure. Both are equally fast.
+
+ The hash table is not thread safe.  If same hash table context is used in
+ multi thread environment concurrency control must be employed.
+
+
  • SilcHashTable +
  • SilcHashTableList +
  • SilcHashFunction +
  • SilcHashCompare +
  • SilcHashDestructor +
  • SilcHashForeach +
  • silc_hash_table_alloc +
  • silc_hash_table_free +
  • silc_hash_table_size +
  • silc_hash_table_count +
  • silc_hash_table_add +
  • silc_hash_table_replace +
  • silc_hash_table_del +
  • silc_hash_table_del_by_context +
  • silc_hash_table_find +
  • silc_hash_table_find_by_context +
  • silc_hash_table_find_foreach +
  • silc_hash_table_foreach +
  • silc_hash_table_rehash +
  • silc_hash_table_list +
  • silc_hash_table_list_reset +
  • silc_hash_table_get +
  • silc_hash_table_add_ext +
  • silc_hash_table_replace_ext +
  • silc_hash_table_del_ext +
  • silc_hash_table_del_by_context_ext +
  • silc_hash_table_find_ext +
  • silc_hash_table_find_by_context_ext +
  • silc_hash_table_find_foreach_ext +
  • silc_hash_table_rehash_ext + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchashtable.xref b/docs/toolkit/manual/silchashtable.xref new file mode 100644 index 0000000..3a83d19 --- /dev/null +++ b/docs/toolkit/manual/silchashtable.xref @@ -0,0 +1,37 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silchashtable.h" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 0 + "SILC Hash Table Interface" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 1 + "SilcHashTable" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 5 + "SilcHashTableList" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 5 + "SilcHashFunction" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "SilcHashCompare" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "SilcHashDestructor" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "SilcHashForeach" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_alloc" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_free" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_size" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_count" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_add" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_replace" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_del" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_del_by_context" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_find" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_find_by_context" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_find_foreach" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_foreach" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_rehash" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_list" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_list_reset" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_get" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_add_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_replace_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_del_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_del_by_context_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_find_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_find_by_context_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_find_foreach_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + "silc_hash_table_rehash_ext" "/home/priikone/silc1/doc/toolkit/silchashtable.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silchmac-SilcHmac.html b/docs/toolkit/manual/silchmac-SilcHmac.html new file mode 100644 index 0000000..3920927 --- /dev/null +++ b/docs/toolkit/manual/silchmac-SilcHmac.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHmac

    + + +NAME + +
    
+    typedef struct SilcHmacStruct *SilcHmac;
+
+
    +DESCRIPTION + +
    
+    This context is the actual HMAC context and is allocated
+    by silc_hmac_alloc and given as argument usually to all
+    silc_hmac_* functions.  It is freed by the silc_hmac_free
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-SilcHmacObject.html b/docs/toolkit/manual/silchmac-SilcHmacObject.html new file mode 100644 index 0000000..cf6929f --- /dev/null +++ b/docs/toolkit/manual/silchmac-SilcHmacObject.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHmacObject

    + + +NAME + +
    
+    typedef struct { ... } SilcHmacObject;
+
+
    +DESCRIPTION + +
    
+    This structure represents one HMAC.  The HMAC's name and the
+    MAC length is defined in the structure.  This structure is
+    then given as argument to the silc_hmac_register.  That function
+    is used to register all HMACs into SILC.  They can be then
+    allocated by the name found in this structure by calling the
+    silc_hmac_alloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_alloc.html b/docs/toolkit/manual/silchmac-silc_hmac_alloc.html new file mode 100644 index 0000000..7472bfd --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_alloc.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_hmac_alloc(const char *name, SilcHash hash,
+                         SilcHmac *new_hmac);
+
+
    +DESCRIPTION + +
    
+    Allocates a new SilcHmac object of name of `name'.  The `hash' may
+    be provided as argument.  If provided it is used as the hash function
+    of the HMAC.  If it is NULL then the hash function is allocated and
+    the name of the hash algorithm is derived from the `name'.  Returns
+    FALSE if such HMAC does not exist.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_final.html b/docs/toolkit/manual/silchmac-silc_hmac_final.html new file mode 100644 index 0000000..f8ed92c --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_final.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_final

    + + +SYNOPSIS + +
    
+    void silc_hmac_final(SilcHmac hmac, unsigned char *return_hash,
+                         SilcUInt32 *return_len);
+
+
    +DESCRIPTION + +
    
+    This function is used to produce the final MAC from the data
+    that has been added to the HMAC context by calling the
+    silc_hmac_update function.  The MAC is copied in to the
+    `return_hash' pointer which must be at least the size that
+    the silc_hmac_len returns.  The length of the MAC is still
+    returned into `return_len'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_free.html b/docs/toolkit/manual/silchmac-silc_hmac_free.html new file mode 100644 index 0000000..972a70a --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_free.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_free

    + + +SYNOPSIS + +
    
+    void silc_hmac_free(SilcHmac hmac);
+
+
    +DESCRIPTION + +
    
+    Frees the allocated HMAC context.  The key that may have been set
+    with the silc_hmac_set_key is also destroyed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_get_hash.html b/docs/toolkit/manual/silchmac-silc_hmac_get_hash.html new file mode 100644 index 0000000..5e3b8eb --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_get_hash.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_get_hash

    + + +SYNOPSIS + +
    
+    SilcHash silc_hmac_get_hash(SilcHmac hmac);
+
+
    +DESCRIPTION + +
    
+    Returns the SilcHash context that has been associated with the
+    HMAC context.  The caller must not free the returned context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_get_key.html b/docs/toolkit/manual/silchmac-silc_hmac_get_key.html new file mode 100644 index 0000000..de19d8b --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_get_key.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_get_key

    + + +SYNOPSIS + +
    
+    const unsigned char *
+    silc_hmac_get_key(SilcHmac hmac, SilcUInt32 *key_len);
+
+
    +DESCRIPTION + +
    
+    Returns the key data from the `hmac' set with silc_hamc_set_key.
+    The caller must not free the returned pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_get_name.html b/docs/toolkit/manual/silchmac-silc_hmac_get_name.html new file mode 100644 index 0000000..1968161 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_get_name.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_get_name

    + + +SYNOPSIS + +
    
+    const char *silc_hmac_get_name(SilcHmac hmac);
+
+
    +DESCRIPTION + +
    
+    Returns the name of the HMAC context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_get_supported.html b/docs/toolkit/manual/silchmac-silc_hmac_get_supported.html new file mode 100644 index 0000000..712b47c --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_get_supported.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_get_supported

    + + +SYNOPSIS + +
    
+    char *silc_hmac_get_supported(void);
+
+
    +DESCRIPTION + +
    
+    Returns comma (`,') separated list of registered HMACs.  This is
+    used for example when sending supported HMAC list during the SILC
+    Key Exchange protocol (SKE).  The caller must free the returned
+    pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_init.html b/docs/toolkit/manual/silchmac-silc_hmac_init.html new file mode 100644 index 0000000..a7e8fa6 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_init.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_init

    + + +SYNOPSIS + +
    
+    void silc_hmac_init(SilcHmac hmac);
+
+
    +DESCRIPTION + +
    
+    Sometimes calling the silc_hmac_make might not be the most
+    optimal case of doing MACs.  If you have a lot of different data
+    that you need to put together for computing a MAC you may either
+    put them into a buffer and compute the MAC from the buffer by
+    calling the silc_hmac_make, or you can use the silc_hmac_init,
+    silc_hmac_update and silc_hmac_final to do the MAC.  This function
+    prepares the allocated HMAC context for this kind of MAC
+    computation.  The caller must have been called the function
+    silc_hmac_set_key before calling this function.  To add the
+    data to be used in the MAC computation call the silc_hmac_update
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_init_with_key.html b/docs/toolkit/manual/silchmac-silc_hmac_init_with_key.html new file mode 100644 index 0000000..23fa141 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_init_with_key.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_init_with_key

    + + +SYNOPSIS + +
    
+    void silc_hmac_init_with_key(SilcHmac hmac, const unsigned char *key,
+                                 SilcUInt32 key_len);
+
+
    +DESCRIPTION + +
    
+    Same as silc_hmac_init but initializes with specific key.  The
+    key that may have been set with silc_hmac_set_key is ignored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_is_supported.html b/docs/toolkit/manual/silchmac-silc_hmac_is_supported.html new file mode 100644 index 0000000..3633269 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_is_supported.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_is_supported

    + + +SYNOPSIS + +
    
+    SilcBool silc_hmac_is_supported(const char *name);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the HMAC indicated by the `name' exists.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_len.html b/docs/toolkit/manual/silchmac-silc_hmac_len.html new file mode 100644 index 0000000..3ce38db --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_len.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hmac_len(SilcHmac hmac);
+
+
    +DESCRIPTION + +
    
+    Returns the length of the MAC that the HMAC will produce.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_make.html b/docs/toolkit/manual/silchmac-silc_hmac_make.html new file mode 100644 index 0000000..dc8d4e1 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_make.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_make

    + + +SYNOPSIS + +
    
+    void silc_hmac_make(SilcHmac hmac, unsigned char *data,
+                        SilcUInt32 data_len, unsigned char *return_hash,
+                        SilcUInt32 *return_len);
+
+
    +DESCRIPTION + +
    
+    Computes a MAC from a data buffer indicated by the `data' of the
+    length of `data_len'.  The returned MAC is copied into the
+    `return_hash' pointer which must be at least the size of the
+    value silc_hmac_len returns.  The returned length is still
+    returned to `return_len'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_make_truncated.html b/docs/toolkit/manual/silchmac-silc_hmac_make_truncated.html new file mode 100644 index 0000000..db952b7 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_make_truncated.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_make_truncated

    + + +SYNOPSIS + +
    
+    void silc_hmac_make_truncated(SilcHmac hmac,
+                                  unsigned char *data,
+                                  SilcUInt32 data_len,
+                                  SilcUInt32 truncated_len,
+                                  unsigned char *return_hash);
+
+
    +DESCRIPTION + +
    
+    Same as the silc_hmac_make except that the returned MAC is
+    truncated to the length indicated by the `truncated_len'.  Some
+    special applications may need this function.  The `return_hash'
+    must be at least the size of `truncated_len'.
+
+
    +NOTES + +
    
+    For security reasons, one should not truncate to less than half
+    of the length of the true MAC lenght.  However, since this routine
+    may be used to non-critical applications this allows these dangerous
+    truncations.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_make_with_key.html b/docs/toolkit/manual/silchmac-silc_hmac_make_with_key.html new file mode 100644 index 0000000..8d2e7d4 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_make_with_key.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_make_with_key

    + + +SYNOPSIS + +
    
+    void silc_hmac_make_with_key(SilcHmac hmac, unsigned char *data,
+                                 SilcUInt32 data_len,
+                                 unsigned char *key, SilcUInt32 key_len,
+                                 unsigned char *return_hash,
+                                 SilcUInt32 *return_len);
+
+
    +DESCRIPTION + +
    
+    Same as the silc_hmac_make but takes the key for the HMAC as
+    argument.  If this is used the key that may have been set by calling
+    silc_hmac_set_key is ignored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_register.html b/docs/toolkit/manual/silchmac-silc_hmac_register.html new file mode 100644 index 0000000..72244d9 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_register.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_register

    + + +SYNOPSIS + +
    
+    SilcBool silc_hmac_register(const SilcHmacObject *hmac);
+
+
    +DESCRIPTION + +
    
+    Registers a new HMAC into the SILC. This function is used at the
+    initialization of the SILC.  All registered HMACs should be
+    unregistered with silc_hmac_unregister.  The `hmac' includes the
+    name of the HMAC and the length of the MAC.  Usually this
+    function is not called directly.  Instead, application can call
+    the silc_hmac_register_default to register all default HMACs
+    that are builtin the sources.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_register_default.html b/docs/toolkit/manual/silchmac-silc_hmac_register_default.html new file mode 100644 index 0000000..f7d4f02 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_register_default.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_register_default

    + + +SYNOPSIS + +
    
+    SilcBool silc_hmac_register_default(void);
+
+
    +DESCRIPTION + +
    
+    Registers all default HMACs into the SILC.  These are the HMACs
+    that are builtin in the sources.  See the list of default HMACs
+    in the silchmac.c source file.  The application may use this
+    to register default HMACs if specific HMAC in any specific order
+    is not wanted (application's configuration usually may decide
+    the order of the registration, in which case this should not be
+    used).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_set_key.html b/docs/toolkit/manual/silchmac-silc_hmac_set_key.html new file mode 100644 index 0000000..65024d2 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_set_key.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_set_key

    + + +SYNOPSIS + +
    
+    void silc_hmac_set_key(SilcHmac hmac, const unsigned char *key,
+                           SilcUInt32 key_len);
+
+
    +DESCRIPTION + +
    
+    Sets the key to be used in the HMAC operation.  This must be set
+    before calling silc_hmac_make or silc_hmac_final functions.  If
+    you do not want to set the key you can still produce a MAC by
+    calling the silc_hmac_make_with_key where you give the key as
+    argument.  Usually application still wants to set the key.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_unregister.html b/docs/toolkit/manual/silchmac-silc_hmac_unregister.html new file mode 100644 index 0000000..5f169aa --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_unregister.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_unregister

    + + +SYNOPSIS + +
    
+    SilcBool silc_hmac_unregister(SilcHmacObject *hmac);
+
+
    +DESCRIPTION + +
    
+    Unregister a HMAC from SILC by the HMAC structure `hmac'.  This
+    should be called for all registered HMAC's.  Returns FALSE on
+    error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_unregister_all.html b/docs/toolkit/manual/silchmac-silc_hmac_unregister_all.html new file mode 100644 index 0000000..fed9d3b --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_unregister_all.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_unregister_all

    + + +SYNOPSIS + +
    
+    SilcBool silc_hmac_unregister_all(void);
+
+
    +DESCRIPTION + +
    
+    Unregisters all registered HMACs.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac-silc_hmac_update.html b/docs/toolkit/manual/silchmac-silc_hmac_update.html new file mode 100644 index 0000000..9eee112 --- /dev/null +++ b/docs/toolkit/manual/silchmac-silc_hmac_update.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hmac_update

    + + +SYNOPSIS + +
    
+    void silc_hmac_update(SilcHmac hmac, const unsigned char *data,
+                          SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    This function may be called to add data to be used in the MAC
+    computation.  This can be called multiple times to add data from
+    many sources before actually performing the HMAC.  Once you've
+    added all the data you need you can call the silc_hmac_final to
+    actually produce the MAC.
+
+
    +EXAMPLE + +
    
+    unsigned char mac[20];
+    SilcUInt32 mac_len;
+
+    silc_hmac_init(hmac);
+    silc_hmac_update(hmac, data, data_len);
+    silc_hmac_update(hmac, more_data, more_data_len);
+    silc_hmac_final(hmac, mac, &mac_len);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HMAC Interface
    +SilcHmac
    +SilcHmacObject
    +silc_hmac_register
    +silc_hmac_unregister
    +silc_hmac_register_default
    +silc_hmac_unregister_all
    +silc_hmac_alloc
    +silc_hmac_free
    +silc_hmac_is_supported
    +silc_hmac_get_supported
    +silc_hmac_len
    +silc_hmac_get_hash
    +silc_hmac_get_name
    +silc_hmac_set_key
    +silc_hmac_get_key
    +silc_hmac_make
    +silc_hmac_make_with_key
    +silc_hmac_make_truncated
    +silc_hmac_init
    +silc_hmac_init_with_key
    +silc_hmac_update
    +silc_hmac_final
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac.html b/docs/toolkit/manual/silchmac.html new file mode 100644 index 0000000..1248e5a --- /dev/null +++ b/docs/toolkit/manual/silchmac.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silchmac.html + + + + +
    + +SILC HMAC Interface
    Header: silchmac.h

    + + +DESCRIPTION + +
    
+    This is the interface for HMAC, or the keyed hash values, that are
+    used for packet and message authentication.  These routines uses
+    already implemented hash functions from the SilcHashAPI. These
+    routines were created according to RFC 2104.
+
+
  • SilcHmac +
  • SilcHmacObject +
  • silc_hmac_register +
  • silc_hmac_unregister +
  • silc_hmac_register_default +
  • silc_hmac_unregister_all +
  • silc_hmac_alloc +
  • silc_hmac_free +
  • silc_hmac_is_supported +
  • silc_hmac_get_supported +
  • silc_hmac_len +
  • silc_hmac_get_hash +
  • silc_hmac_get_name +
  • silc_hmac_set_key +
  • silc_hmac_get_key +
  • silc_hmac_make +
  • silc_hmac_make_with_key +
  • silc_hmac_make_truncated +
  • silc_hmac_init +
  • silc_hmac_init_with_key +
  • silc_hmac_update +
  • silc_hmac_final + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchmac.xref b/docs/toolkit/manual/silchmac.xref new file mode 100644 index 0000000..a0e2ff9 --- /dev/null +++ b/docs/toolkit/manual/silchmac.xref @@ -0,0 +1,29 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silchmac.h" "/home/priikone/silc1/doc/toolkit/silchmac.html" 0 + "SILC HMAC Interface" "/home/priikone/silc1/doc/toolkit/silchmac.html" 1 + "SilcHmac" "/home/priikone/silc1/doc/toolkit/silchmac.html" 5 + "SilcHmacObject" "/home/priikone/silc1/doc/toolkit/silchmac.html" 5 + "silc_hmac_register" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_unregister" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_register_default" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_unregister_all" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_alloc" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_free" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_is_supported" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_get_supported" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_len" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_get_hash" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_get_name" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_set_key" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_get_key" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_make" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_make_with_key" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_make_truncated" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_init" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_init_with_key" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_update" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + "silc_hmac_final" "/home/priikone/silc1/doc/toolkit/silchmac.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silchttplib.html b/docs/toolkit/manual/silchttplib.html new file mode 100644 index 0000000..2eaf52e --- /dev/null +++ b/docs/toolkit/manual/silchttplib.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC HTTP Library +
    +Directory: lib/silchttp/ +
    +Library: libhttp.a, libhttp.lib +

    +Introduction + +

    +SILC HTTP Library provides currently interface for very simple HTTP +Server. It also provides support to serve PHP pages through the server. + +

    + +
  • SILC HTTP Server Interface +
  • SILC HTTP PHP Translator +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpphp-silc_http_php.html b/docs/toolkit/manual/silchttpphp-silc_http_php.html new file mode 100644 index 0000000..8f39048 --- /dev/null +++ b/docs/toolkit/manual/silchttpphp-silc_http_php.html @@ -0,0 +1,215 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_php

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_http_php(char *php_data);
+
+
    +DESCRIPTION + +
    
+    Executes the PHP code contained in the buffer `php_data' and returns
+    the result in the allocated SilcBuffer or NULL on error.  The caller
+    must free the returned buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP PHP Translator
    +silc_http_php
    +silc_http_php_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpphp-silc_http_php_file.html b/docs/toolkit/manual/silchttpphp-silc_http_php_file.html new file mode 100644 index 0000000..d4dc2af --- /dev/null +++ b/docs/toolkit/manual/silchttpphp-silc_http_php_file.html @@ -0,0 +1,215 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_php_file

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_http_php_file(const char *filepath);
+
+
    +DESCRIPTION + +
    
+    Reads the PHP contents from the file indicated by the `filepath' and
+    executes the PHP code and returns the result in the allocated
+    SilcBuffer or NULL on error.  The caller must free the returned buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP PHP Translator
    +silc_http_php
    +silc_http_php_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpphp.html b/docs/toolkit/manual/silchttpphp.html new file mode 100644 index 0000000..604faa1 --- /dev/null +++ b/docs/toolkit/manual/silchttpphp.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silchttpphp.html + + + + +
    + +SILC HTTP PHP Translator
    Header: silchttpphp.h

    + + +DESCRIPTION + +
    
+ PHP translator for SILC HTTP Server, enabling PHP support for the pages
+ served through the SILC HTTP Server interface (silchttpserver.h).
+ The PHP must be installed in the system and must be in the execution
+ path for the interface to work.
+
+
  • silc_http_php +
  • silc_http_php_file + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpphp.xref b/docs/toolkit/manual/silchttpphp.xref new file mode 100644 index 0000000..ab8abda --- /dev/null +++ b/docs/toolkit/manual/silchttpphp.xref @@ -0,0 +1,9 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silchttpphp.h" "/home/priikone/silc1/doc/toolkit/silchttpphp.html" 0 + "SILC HTTP PHP Translator" "/home/priikone/silc1/doc/toolkit/silchttpphp.html" 1 + "silc_http_php" "/home/priikone/silc1/doc/toolkit/silchttpphp.html" 4 + "silc_http_php_file" "/home/priikone/silc1/doc/toolkit/silchttpphp.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silchttpserver-SilcHttpConnection.html b/docs/toolkit/manual/silchttpserver-SilcHttpConnection.html new file mode 100644 index 0000000..2adf700 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-SilcHttpConnection.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHttpConnection

    + + +NAME + +
    
+    typedef struct SilcHttpConnectionStruct *SilcHttpConnection;
+
+
    +DESCRIPTION + +
    
+    HTTP connection context.  This is allocated by the library and
+    delivered to application in SilcHttpServerCallback callbcak function.
+    It is given as argument to many silc_http_server_* functions.
+    It is freed automatically by the library.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-SilcHttpServer.html b/docs/toolkit/manual/silchttpserver-SilcHttpServer.html new file mode 100644 index 0000000..892fe79 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-SilcHttpServer.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcHttpServer

    + + +NAME + +
    
+    typedef struct SilcHttpServerStruct *SilcHttpServer;
+
+
    +DESCRIPTION + +
    
+    The actual HTTP server allocated with silc_http_server_alloc and
+    freed with silc_http_server_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-SilcHttpServerCallback.html b/docs/toolkit/manual/silchttpserver-SilcHttpServerCallback.html new file mode 100644 index 0000000..51a78a5 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-SilcHttpServerCallback.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcHttpServerCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcHttpServerCallback)(SilcHttpServer httpd,
+                                           SilcHttpConnection conn,
+                                           const char *uri,
+                                           const char *method,
+                                           SilcBuffer data,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    The HTTP request callback that is called everytime a new HTTP request
+    comes from a HTTP client.  The `uri' is the requested URI (web page),
+    and the `method' is the HTTP request method (GET, POST, etc.).  The
+    `data' is non-NULL only if the `method' is POST, and it includes the
+    the POST data.
+
+    The requested web page must be returned to the HTTP client from this
+    callback by calling silc_http_server_send or error is returned by
+    calling silc_http_server_send_error.
+
+    The silc_http_server_get_header may be called to find a specific
+    HTTP header from this request.  New headers may be added to the
+    reply by calling silc_http_server_add_header.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-silc_http_server_add_header.html b/docs/toolkit/manual/silchttpserver-silc_http_server_add_header.html new file mode 100644 index 0000000..d0bc682 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-silc_http_server_add_header.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_server_add_header

    + + +SYNOPSIS + +
    
+    SilcBool silc_http_server_add_header(SilcHttpServer httpd,
+                                         SilcHttpConnection conn,
+                                         const char *field,
+                                         const char *value);
+
+
    +DESCRIPTION + +
    
+    Adds a new header to the HTTP headers to be sent back to the
+    HTTP client.  This may be called to add needed headers to the
+    HTTP reply.
+
+
    +EXAMPLE + +
    
+    silc_http_server_add_header(httpd, conn, "Content-Type", "image/jpeg");
+    silc_http_server_send(httpd, conn, image_data);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-silc_http_server_alloc.html b/docs/toolkit/manual/silchttpserver-silc_http_server_alloc.html new file mode 100644 index 0000000..56a4c33 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-silc_http_server_alloc.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_server_alloc

    + + +SYNOPSIS + +
    
+    SilcHttpServer
+    silc_http_server_alloc(const char *ip, SilcUInt16 port,
+                           SilcSchedule schedule,
+                           SilcHttpServerCallback callback, void *context);
+
+
    +DESCRIPTION + +
    
+    Allocates HTTP server and binds it to the IP address `ip' on the
+    `port'.  The `callback' with `context' will be called everytime a new
+    HTTP request comes to the server from a HTTP client.  In that callback
+    the caller must then reply with the requested Web page or with error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-silc_http_server_free.html b/docs/toolkit/manual/silchttpserver-silc_http_server_free.html new file mode 100644 index 0000000..352655d --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-silc_http_server_free.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_server_free

    + + +SYNOPSIS + +
    
+    void silc_http_server_free(SilcHttpServer httpd);
+
+
    +DESCRIPTION + +
    
+    Close HTTP server and free all resources.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-silc_http_server_get_header.html b/docs/toolkit/manual/silchttpserver-silc_http_server_get_header.html new file mode 100644 index 0000000..17a3436 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-silc_http_server_get_header.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_server_get_header

    + + +SYNOPSIS + +
    
+    const char *silc_http_server_get_header(SilcHttpServer httpd,
+                                            SilcHttpConnection conn,
+                                            const char *field);
+
+
    +DESCRIPTION + +
    
+    Finds a header field indicated by `field' from the current HTTP
+    request sent by the HTTP client.  Returns the field value or NULL
+    if such header field does not exist.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-silc_http_server_send.html b/docs/toolkit/manual/silchttpserver-silc_http_server_send.html new file mode 100644 index 0000000..24a7d8c --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-silc_http_server_send.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_server_send

    + + +SYNOPSIS + +
    
+    SilcBool silc_http_server_send(SilcHttpServer httpd,
+                                   SilcHttpConnection conn,
+                                   SilcBuffer data);
+
+
    +DESCRIPTION + +
    
+    Send the HTTP data indicated by `data' buffer into the connection
+    indicated by `conn'.  Returns TRUE after the data is sent, and FALSE
+    if error occurred.  Usually the `data' would be the requested web page.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver-silc_http_server_send_error.html b/docs/toolkit/manual/silchttpserver-silc_http_server_send_error.html new file mode 100644 index 0000000..844a2d8 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver-silc_http_server_send_error.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_http_server_send_error

    + + +SYNOPSIS + +
    
+    SilcBool silc_http_server_send_error(SilcHttpServer httpd,
+                                         SilcHttpConnection conn,
+                                         const char *error,
+                                         const char *error_message);
+
+
    +DESCRIPTION + +
    
+    Send HTTP error back to the connection indicated by `conn'.  The
+    `error' is one of the 4xx or 5xx errors defined by the HTTP protocol.
+    The `error_message' is the optional error message sent to the
+    connection.  Returns FALSE if the error could not be sent.
+
+    Typical errors are: 400 Bad Request
+                        403 Forbidden
+                        404 Not Found
+
+
    +EXAMPLE + +
    
+    silc_http_server_send_error(httpd, conn, "400 Bad Request",
+                                "<body><h1>400 Bad Request!!</h1></body>");
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC HTTP Server Interface
    +SilcHttpServer
    +SilcHttpConnection
    +SilcHttpServerCallback
    +silc_http_server_alloc
    +silc_http_server_free
    +silc_http_server_send
    +silc_http_server_send_error
    +silc_http_server_get_header
    +silc_http_server_add_header
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver.html b/docs/toolkit/manual/silchttpserver.html new file mode 100644 index 0000000..0433da7 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silchttpserver.html + + + + +
    + +SILC HTTP Server Interface
    Header: silchttpserver.h

    + + +DESCRIPTION + +
    
+ Very simple HTTP server interface.  This HTTP server supports basic HTTP
+ features.  All pages on the server are dynamically created by the caller
+ of this interface.  The server does not support plugins, modules, cgi-bin,
+ server-side includes or any other special features.  Naturally, the caller
+ of this interface may itself implement such features.
+
+
  • SilcHttpServer +
  • SilcHttpConnection +
  • SilcHttpServerCallback +
  • silc_http_server_alloc +
  • silc_http_server_free +
  • silc_http_server_send +
  • silc_http_server_send_error +
  • silc_http_server_get_header +
  • silc_http_server_add_header + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silchttpserver.xref b/docs/toolkit/manual/silchttpserver.xref new file mode 100644 index 0000000..1dfedc2 --- /dev/null +++ b/docs/toolkit/manual/silchttpserver.xref @@ -0,0 +1,16 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silchttpserver.h" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 0 + "SILC HTTP Server Interface" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 1 + "SilcHttpServer" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 5 + "SilcHttpConnection" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 5 + "SilcHttpServerCallback" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 4 + "silc_http_server_alloc" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 4 + "silc_http_server_free" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 4 + "silc_http_server_send" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 4 + "silc_http_server_send_error" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 4 + "silc_http_server_get_header" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 4 + "silc_http_server_add_header" "/home/priikone/silc1/doc/toolkit/silchttpserver.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcid-SILC_ID_CHANNEL_COMPARE.html b/docs/toolkit/manual/silcid-SILC_ID_CHANNEL_COMPARE.html new file mode 100644 index 0000000..bc788b3 --- /dev/null +++ b/docs/toolkit/manual/silcid-SILC_ID_CHANNEL_COMPARE.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ID_CHANNEL_COMPARE

    + + +NAME + +
    
+    #define SILC_ID_CHANNEL_COMPARE ...
+
+
    +DESCRIPTION + +
    
+    Compares Channel ID's. Returns TRUE if they match.
+
+
    +SOURCE + +
        #define SILC_ID_CHANNEL_COMPARE(id1, id2) \
+      SILC_ID_COMPARE(id1, id2, sizeof(SilcChannelID))
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SILC_ID_CLIENT_COMPARE.html b/docs/toolkit/manual/silcid-SILC_ID_CLIENT_COMPARE.html new file mode 100644 index 0000000..bbcaeb3 --- /dev/null +++ b/docs/toolkit/manual/silcid-SILC_ID_CLIENT_COMPARE.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ID_CLIENT_COMPARE

    + + +NAME + +
    
+    #define SILC_ID_CLIENT_COMPARE ...
+
+
    +DESCRIPTION + +
    
+    Compares Client ID's. Returns TRUE if they match.
+
+
    +SOURCE + +
        #define SILC_ID_CLIENT_COMPARE(id1, id2) \
+      SILC_ID_COMPARE(id1, id2, sizeof(SilcClientID))
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SILC_ID_COMPARE.html b/docs/toolkit/manual/silcid-SILC_ID_COMPARE.html new file mode 100644 index 0000000..3b83a41 --- /dev/null +++ b/docs/toolkit/manual/silcid-SILC_ID_COMPARE.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ID_COMPARE

    + + +NAME + +
    
+    #define SILC_ID_COMPARE ...
+
+
    +DESCRIPTION + +
    
+    Compares two ID's. Returns TRUE if they match and FALSE if they do
+    not.
+
+
    +SOURCE + +
        #define SILC_ID_COMPARE(id1, id2, len) (!memcmp(id1, id2, len))
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SILC_ID_COMPARE_HASH.html b/docs/toolkit/manual/silcid-SILC_ID_COMPARE_HASH.html new file mode 100644 index 0000000..b2b5ee8 --- /dev/null +++ b/docs/toolkit/manual/silcid-SILC_ID_COMPARE_HASH.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ID_COMPARE_HASH

    + + +NAME + +
    
+    #define SILC_ID_COMPARE_HASH ...
+
+
    +DESCRIPTION + +
    
+    Compares the nickname hash of the Client ID. Returns TRUE if
+    they match. Since the nickname hash is based on the nickname of
+    the client this can be used to search the ID by nickname (taking
+    the hash out of it) or using the hash from the ID.
+
+
    +SOURCE + +
        #define SILC_ID_COMPARE_HASH(id1, id2) \
+      (!memcmp((id1)->hash, (id2)->hash, CLIENTID_HASH_LEN))
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SILC_ID_COMPARE_TYPE.html b/docs/toolkit/manual/silcid-SILC_ID_COMPARE_TYPE.html new file mode 100644 index 0000000..c03c074 --- /dev/null +++ b/docs/toolkit/manual/silcid-SILC_ID_COMPARE_TYPE.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ID_COMPARE_TYPE

    + + +NAME + +
    
+    #define SILC_ID_COMPARE_TYPE ...
+
+
    +DESCRIPTION + +
    
+    Compares two ID's by type. Returns TRUE if they match.
+
+
    +SOURCE + +
        #define SILC_ID_COMPARE_TYPE(id1, id2, type)                    \
+      (type == SILC_ID_SERVER ? SILC_ID_SERVER_COMPARE(id1, id2) :  \
+       type == SILC_ID_CLIENT ? SILC_ID_CLIENT_COMPARE(id1, id2) :  \
+       SILC_ID_CHANNEL_COMPARE(id1, id2))
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SILC_ID_GET_ID.html b/docs/toolkit/manual/silcid-SILC_ID_GET_ID.html new file mode 100644 index 0000000..640d8b4 --- /dev/null +++ b/docs/toolkit/manual/silcid-SILC_ID_GET_ID.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ID_GET_ID

    + + +NAME + +
    
+    #define SILC_ID_GET_ID ...
+
+
    +DESCRIPTION + +
    
+    Returns the ID type specific pointer from the SilcID structure.  As
+    the SilcID is able to house all types of IDs this macro can be used
+    to get the specific ID from the structure by its type.
+
+
    +SOURCE + +
        #define SILC_ID_GET_ID(id)                                              \
+      ((id).type == SILC_ID_CLIENT  ? (void *)&(id).u.client_id :           \
+       (id).type == SILC_ID_SERVER  ? (void *)&(id).u.server_id :           \
+       (void *)&(id).u.channel_id)
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SILC_ID_SERVER_COMPARE.html b/docs/toolkit/manual/silcid-SILC_ID_SERVER_COMPARE.html new file mode 100644 index 0000000..b162041 --- /dev/null +++ b/docs/toolkit/manual/silcid-SILC_ID_SERVER_COMPARE.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ID_SERVER_COMPARE

    + + +NAME + +
    
+    #define SILC_ID_SERVER_COMPARE ...
+
+
    +DESCRIPTION + +
    
+    Compares Server ID's. Returns TRUE if they match.
+
+
    +SOURCE + +
        #define SILC_ID_SERVER_COMPARE(id1, id2) \
+      SILC_ID_COMPARE(id1, id2, sizeof(SilcServerID))
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SilcChannelID.html b/docs/toolkit/manual/silcid-SilcChannelID.html new file mode 100644 index 0000000..46d7510 --- /dev/null +++ b/docs/toolkit/manual/silcid-SilcChannelID.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcChannelID

    + + +NAME + +
    
+    typedef struct { ... } SilcChannelID;
+
+
    +DESCRIPTION + +
    
+    64 or 160 bit SilcChannel ID structure:
+
+     n bit Router's ServerID IP address [bits 1-32 or bits 1-128]
+    16 bit Router's ServerID port [bits 33-48 or bits 129-144]
+    16 bit random number
+
+
    +SOURCE + +
        typedef struct SilcChannelIDStruct {
+      SilcIDIP ip;                  /* n bit IP address */
+      SilcUInt16 port;              /* 16 bit port */
+      SilcUInt16 rnd;               /* 16 bit random number */
+    } SilcChannelID;
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SilcClientID.html b/docs/toolkit/manual/silcid-SilcClientID.html new file mode 100644 index 0000000..e928ccf --- /dev/null +++ b/docs/toolkit/manual/silcid-SilcClientID.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcClientID

    + + +NAME + +
    
+    typedef struct { ... } SilcClientID;
+
+
    +DESCRIPTION + +
    
+    128 or 224 bit SilcClientID structure:
+
+      n bit ServerID IP address [bits 1-32 or bits 1-128]
+      8 bit random number
+     88 bit hash value from lowercase nickname
+
+
    +SOURCE + +
        typedef struct SilcClientIDStruct {
+      SilcIDIP ip;                                  /* n bit IP address */
+      unsigned char rnd;                            /* 8 bit random number */
+      unsigned char hash[CLIENTID_HASH_LEN];        /* 88 bit MD5 hash */
+    } SilcClientID;
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SilcID.html b/docs/toolkit/manual/silcid-SilcID.html new file mode 100644 index 0000000..b6fd546 --- /dev/null +++ b/docs/toolkit/manual/silcid-SilcID.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcID

    + + +NAME + +
    
+    typedef struct { ... } SilcID;
+
+
    +DESCRIPTION + +
    
+    The generic ID structure that can represent SilcClientID, SilcServerID
+    and SilcChannelID.  The silc_id_payload_parse_id returns the ID in the
+    SilcID structure.  Other routines except either SilcClientID,
+    SilcServerID or SilcChannelID as a void pointer.
+
+
    +SOURCE + +
        typedef struct SilcIDStruct {
+      union {
+        SilcServerID server_id;
+        SilcChannelID channel_id;
+        SilcClientID client_id;
+      } u;
+      SilcIdType type;
+    } SilcID;
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SilcIDIP.html b/docs/toolkit/manual/silcid-SilcIDIP.html new file mode 100644 index 0000000..eb2cc5d --- /dev/null +++ b/docs/toolkit/manual/silcid-SilcIDIP.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcIDIP

    + + +NAME + +
    
+    typedef struct { ... } SilcIDIP;
+
+
    +DESCRIPTION + +
    
+    Generic IP address structure to indicate either IPv4 or IPv6 address.
+    This structure is used inside all SILC ID's. The true length of the
+    ID depends of the length of the IP address.
+
+
    +SOURCE + +
        typedef struct SilcIDIPStruct {
+      unsigned char data[16];       /* IP data (in MSB first order) */
+      SilcUInt8 data_len;           /* Length of the data (4 or 16) */
+    } SilcIDIP;
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SilcIDPayload.html b/docs/toolkit/manual/silcid-SilcIDPayload.html new file mode 100644 index 0000000..e2d94cf --- /dev/null +++ b/docs/toolkit/manual/silcid-SilcIDPayload.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcIDPayload

    + + +NAME + +
    
+    typedef struct SilcIDPayloadStruct *SilcIDPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual ID Payload and is allocated by
+    silc_id_payload_parse and given as argument usually to all
+    silc_id_payload_* functions.  It is freed by the function
+    silc_id_payload_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SilcIdType.html b/docs/toolkit/manual/silcid-SilcIdType.html new file mode 100644 index 0000000..5aa2329 --- /dev/null +++ b/docs/toolkit/manual/silcid-SilcIdType.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcIdType

    + + +NAME + +
    
+    typedef SilcUInt16 SilcIdType;
+
+
    +DESCRIPTION + +
    
+    SILC ID type definitions and the ID types.
+
+
    +SOURCE + +
        typedef SilcUInt16 SilcIdType;
+    
+    /* The SILC ID Types */
+    #define SILC_ID_NONE        0
+    #define SILC_ID_SERVER      1
+    #define SILC_ID_CLIENT      2
+    #define SILC_ID_CHANNEL     3
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-SilcServerID.html b/docs/toolkit/manual/silcid-SilcServerID.html new file mode 100644 index 0000000..e4651db --- /dev/null +++ b/docs/toolkit/manual/silcid-SilcServerID.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcServerID

    + + +NAME + +
    
+    typedef struct { ... } SilcServerID;
+
+
    +DESCRIPTION + +
    
+    64 or 160 bit SilcServerID structure:
+
+     n bit IP address
+    16 bit port
+    16 bit random number
+
+
    +SOURCE + +
        typedef struct SilcServerIDStruct {
+      SilcIDIP ip;                  /* n bit IP address */
+      SilcUInt16 port;              /* 16 bit port */
+      SilcUInt16 rnd;               /* 16 bit random number */
+    } SilcServerID;
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_dup.html b/docs/toolkit/manual/silcid-silc_id_dup.html new file mode 100644 index 0000000..0d98d3d --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_dup.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_dup

    + + +SYNOPSIS + +
    
+    void *silc_id_dup(const void *id, SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Duplicates the ID of the type `type'. The caller must free the
+    duplicated ID.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_get_len.html b/docs/toolkit/manual/silcid-silc_id_get_len.html new file mode 100644 index 0000000..048ff54 --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_get_len.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_get_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_id_get_len(const void *id, SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Returns the true length of the ID of the type `type'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_id2str.html b/docs/toolkit/manual/silcid-silc_id_id2str.html new file mode 100644 index 0000000..76e34d8 --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_id2str.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_id2str

    + + +SYNOPSIS + +
    
+    SilcBool silc_id_id2str(const void *id, SilcIdType type,
+                            unsigned char *ret_id, SilcUInt32 ret_id_size,
+                            SilcUInt32 *ret_id_len);
+
+
    +DESCRIPTION + +
    
+    Converts an ID of type `type' to data. This can be used to
+    convert the ID's to data for inclusion in the packets.  This does
+    not allocate any memory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_encode.html b/docs/toolkit/manual/silcid-silc_id_payload_encode.html new file mode 100644 index 0000000..44bf8f7 --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_encode.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_id_payload_encode(const void *id, SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Encodes ID Payload. The `id' is the ID of the type `type' to put
+    into the payload. Returns the encoded payload buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_encode_data.html b/docs/toolkit/manual/silcid-silc_id_payload_encode_data.html new file mode 100644 index 0000000..222d1c1 --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_encode_data.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_encode_data

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_id_payload_encode_data(const unsigned char *id,
+                                           uin32 id_len, SilcIdType type);
+
+
    +DESCRIPTION + +
    
+    Encodes ID Payload. The `id' is raw ID data of the length of `id_len'
+    of type of `type'. Returns the encoded payload buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_free.html b/docs/toolkit/manual/silcid-silc_id_payload_free.html new file mode 100644 index 0000000..913f9f0 --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_free.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_free

    + + +SYNOPSIS + +
    
+    void silc_id_payload_free(SilcIDPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees the ID Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_get_data.html b/docs/toolkit/manual/silcid-silc_id_payload_get_data.html new file mode 100644 index 0000000..3b872e5 --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_get_data.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_get_data

    + + +SYNOPSIS + +
    
+    unsigned char *silc_id_payload_get_data(SilcIDPayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the raw ID data from the ID Payload. The data is duplicated
+    and the caller must free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_get_id.html b/docs/toolkit/manual/silcid-silc_id_payload_get_id.html new file mode 100644 index 0000000..eac4a0c --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_get_id.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_get_id

    + + +SYNOPSIS + +
    
+    SilcBool silc_id_payload_get_id(SilcIDPayload payload, void *ret_id,
+                                    SilcUInt32 ret_id_len);
+
+
    +DESCRIPTION + +
    
+    Returns the ID in the ID Payload. This does not allocate any memory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_get_len.html b/docs/toolkit/manual/silcid-silc_id_payload_get_len.html new file mode 100644 index 0000000..f3d1024 --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_get_len.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_get_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_id_payload_get_len(SilcIDPayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the length of the ID in the ID Payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_get_type.html b/docs/toolkit/manual/silcid-silc_id_payload_get_type.html new file mode 100644 index 0000000..f2ddcda --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_get_type.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_get_type

    + + +SYNOPSIS + +
    
+    SilcIdType silc_id_payload_get_type(SilcIDPayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the ID type from the ID Payload. The type tells the
+    type of the ID in the payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_parse.html b/docs/toolkit/manual/silcid-silc_id_payload_parse.html new file mode 100644 index 0000000..a99ce0e --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_parse.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_parse

    + + +SYNOPSIS + +
    
+    SilcIDPayload silc_id_payload_parse(const unsigned char *payload,
+                                        SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parses buffer and return ID payload into payload structure. The
+    `buffer' is raw payload buffer.  The caller must free the returned
+    payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_payload_parse_id.html b/docs/toolkit/manual/silcid-silc_id_payload_parse_id.html new file mode 100644 index 0000000..32f5ecd --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_payload_parse_id.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_payload_parse_id

    + + +SYNOPSIS + +
    
+    SilcBool silc_id_payload_parse_id(const unsigned char *data,
+                                      SilcUInt32 len, SilcID *ret_id);
+
+
    +DESCRIPTION + +
    
+    Return ID directly from the raw ID Payload data buffer.  This does
+    not allocate any memory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_str2id.html b/docs/toolkit/manual/silcid-silc_id_str2id.html new file mode 100644 index 0000000..9c66b4a --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_str2id.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_str2id

    + + +SYNOPSIS + +
    
+    SilcBool silc_id_str2id(const unsigned char *id, SilcUInt32 id_len,
+                            SilcIdType type, void *ret_id,
+                            SilcUInt32 ret_id_size);
+
+
    +DESCRIPTION + +
    
+    Converts ID data string to an ID. This can be used to get the
+    ID out of data that has been taken for example from packet.  This
+    does not allocate any memory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid-silc_id_str2id2.html b/docs/toolkit/manual/silcid-silc_id_str2id2.html new file mode 100644 index 0000000..4a7ca1b --- /dev/null +++ b/docs/toolkit/manual/silcid-silc_id_str2id2.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_id_str2id2

    + + +SYNOPSIS + +
    
+    SilcBool silc_id_str2id2(const unsigned char *id, SilcUInt32 id_len,
+                             SilcIdType type, SilcID *ret_id);
+
+
    +DESCRIPTION + +
    
+    Same as silc_id_str2id but returns the ID into SilcID structure in
+    `ret_id' pointer.  This does not allocate any memory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Interface
    +SilcIdType
    +SilcIDIP
    +SilcServerID
    +SilcClientID
    +SilcChannelID
    +SilcID
    +SILC_ID_GET_ID
    +SILC_ID_COMPARE
    +SILC_ID_CLIENT_COMPARE
    +SILC_ID_SERVER_COMPARE
    +SILC_ID_CHANNEL_COMPARE
    +SILC_ID_COMPARE_TYPE
    +SILC_ID_COMPARE_HASH
    +SilcIDPayload
    +silc_id_payload_parse
    +silc_id_payload_parse_id
    +silc_id_payload_encode
    +silc_id_payload_encode_data
    +silc_id_payload_free
    +silc_id_payload_get_type
    +silc_id_payload_get_id
    +silc_id_payload_get_data
    +silc_id_payload_get_len
    +silc_id_id2str
    +silc_id_str2id
    +silc_id_str2id2
    +silc_id_get_len
    +silc_id_dup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid.html b/docs/toolkit/manual/silcid.html new file mode 100644 index 0000000..d254dee --- /dev/null +++ b/docs/toolkit/manual/silcid.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcid.html + + + + +
    + +SILC ID Interface
    Header: silcid.h

    + + +DESCRIPTION + +
    
+ These are important ID types used in SILC. SILC server creates these
+ but SILC client has to handle these as well since these are used in
+ packet sending and reception. However, client never creates these
+ but it receives the correct ID's from server. Clients, servers and
+ channels are identified by the these ID's.
+
+ The ID's are based on IP addresses. The IP address provides a good
+ way to distinguish the ID's from other ID's. The ID's supports both
+ IPv4 and IPv6.
+
+ This file also includes the implementation of the SILC ID Payload
+ parsing and encoding.
+
+
  • SilcIdType +
  • SilcIDIP +
  • SilcServerID +
  • SilcClientID +
  • SilcChannelID +
  • SilcID +
  • SILC_ID_GET_ID +
  • SILC_ID_COMPARE +
  • SILC_ID_CLIENT_COMPARE +
  • SILC_ID_SERVER_COMPARE +
  • SILC_ID_CHANNEL_COMPARE +
  • SILC_ID_COMPARE_TYPE +
  • SILC_ID_COMPARE_HASH +
  • SilcIDPayload +
  • silc_id_payload_parse +
  • silc_id_payload_parse_id +
  • silc_id_payload_encode +
  • silc_id_payload_encode_data +
  • silc_id_payload_free +
  • silc_id_payload_get_type +
  • silc_id_payload_get_id +
  • silc_id_payload_get_data +
  • silc_id_payload_get_len +
  • silc_id_id2str +
  • silc_id_str2id +
  • silc_id_str2id2 +
  • silc_id_get_len +
  • silc_id_dup + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcid.xref b/docs/toolkit/manual/silcid.xref new file mode 100644 index 0000000..dcd3044 --- /dev/null +++ b/docs/toolkit/manual/silcid.xref @@ -0,0 +1,35 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcid.h" "/home/priikone/silc1/doc/toolkit/silcid.html" 0 + "SILC ID Interface" "/home/priikone/silc1/doc/toolkit/silcid.html" 1 + "SilcIdType" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SilcIDIP" "/home/priikone/silc1/doc/toolkit/silcid.html" 5 + "SilcServerID" "/home/priikone/silc1/doc/toolkit/silcid.html" 5 + "SilcClientID" "/home/priikone/silc1/doc/toolkit/silcid.html" 5 + "SilcChannelID" "/home/priikone/silc1/doc/toolkit/silcid.html" 5 + "SilcID" "/home/priikone/silc1/doc/toolkit/silcid.html" 5 + "SILC_ID_GET_ID" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SILC_ID_COMPARE" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SILC_ID_CLIENT_COMPARE" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SILC_ID_SERVER_COMPARE" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SILC_ID_CHANNEL_COMPARE" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SILC_ID_COMPARE_TYPE" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SILC_ID_COMPARE_HASH" "/home/priikone/silc1/doc/toolkit/silcid.html" 8 + "SilcIDPayload" "/home/priikone/silc1/doc/toolkit/silcid.html" 5 + "silc_id_payload_parse" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_parse_id" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_encode" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_encode_data" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_free" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_get_type" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_get_id" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_get_data" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_payload_get_len" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_id2str" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_str2id" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_str2id2" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_get_len" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + "silc_id_dup" "/home/priikone/silc1/doc/toolkit/silcid.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcidcache-SilcIDCache.html b/docs/toolkit/manual/silcidcache-SilcIDCache.html new file mode 100644 index 0000000..71b7940 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-SilcIDCache.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcIDCache

    + + +NAME + +
    
+    typedef struct SilcIDCacheStruct *SilcIDCache;
+
+
    +DESCRIPTION + +
    
+    This context is the actual ID Cache and is allocated by
+    silc_idcache_alloc and given as argument usually to all
+    silc_idcache_* functions.  It is freed by the
+    silc_idcache_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-SilcIDCacheDestructor.html b/docs/toolkit/manual/silcidcache-SilcIDCacheDestructor.html new file mode 100644 index 0000000..bad0730 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-SilcIDCacheDestructor.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcIDCacheDestructor

    + + +SYNOPSIS + +
    
+    typedef void (*SilcIDCacheDestructor)(SilcIDCache cache,
+                                          const SilcIDCacheEntry entry,
+                                          void *destructor_context,
+                                          void *app_context);
+
+
    +DESCRIPTION + +
    
+    Destructor callback given as argument to silc_idcache_alloc.  This
+    is called when an entry is deleted from the cache.  Application
+    must free the contents of the `entry'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-SilcIDCacheEntry.html b/docs/toolkit/manual/silcidcache-SilcIDCacheEntry.html new file mode 100644 index 0000000..1d0300c --- /dev/null +++ b/docs/toolkit/manual/silcidcache-SilcIDCacheEntry.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcIDCacheEntry

    + + +NAME + +
    
+    typedef struct SilcIDCacheEntryStruct { ... } SilcIDCacheEntry;
+
+
    +DESCRIPTION + +
    
+    This is an entry in the SILC ID Cache system.  This context is
+    allocated by adding new entry to ID cache by calling silc_idcache_add.
+    Each of the fields in the structure are allocated by the caller.
+
+
    +SOURCE + +
        typedef struct SilcIDCacheEntryStruct {
+      struct SilcIDCacheEntryStruct *next;
+      void *id;                            /* Associated ID */
+      char *name;                          /* Associated entry name */
+      void *context;                       /* Associated context */
+    } *SilcIDCacheEntry;
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_add.html b/docs/toolkit/manual/silcidcache-silc_idcache_add.html new file mode 100644 index 0000000..52988dd --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_add.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_add

    + + +SYNOPSIS + +
    
+    SilcIDCacheEntry
+    silc_idcache_add(SilcIDCache cache, char *name, void *id, void *context);
+
+
    +DESCRIPTION + +
    
+    Add new entry to the cache.  Returns the allocated cache entry if the
+    entry was added successfully, or NULL if error occurred.  The `name' is
+    the name associated with the ID, the `id' the actual ID and the
+    `context' a caller specific context.  The caller is responsible of
+    freeing the `name' and `id' when the entry is deleted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_alloc.html b/docs/toolkit/manual/silcidcache-silc_idcache_alloc.html new file mode 100644 index 0000000..1df2504 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_alloc.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_alloc

    + + +SYNOPSIS + +
    
+    SilcIDCache silc_idcache_alloc(SilcUInt32 count, SilcIdType id_type,
+                                   SilcIDCacheDestructor destructor,
+                                   void *destructor_context,
+                                   SilcBool delete_id, SilcBool delete_name);
+
+
    +DESCRIPTION + +
    
+    Allocates new ID cache object. The initial amount of allocated entries
+    can be sent as argument. If `count' is 0 the system uses default values.
+    The `id_type' defines the types of the ID's that will be saved to the
+    cache.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_del.html b/docs/toolkit/manual/silcidcache-silc_idcache_del.html new file mode 100644 index 0000000..715b266 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_del.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_del

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_del(SilcIDCache cache, SilcIDCacheEntry entry,
+                              void *app_context);
+
+
    +DESCRIPTION + +
    
+    Delete cache entry from cache.  Returns TRUE if the entry was deleted.
+    The destructor will be called for the entry.  The `app_context' is
+    delivered to the destructor.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_del_by_context.html b/docs/toolkit/manual/silcidcache-silc_idcache_del_by_context.html new file mode 100644 index 0000000..f92d605 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_del_by_context.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_del_by_context

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_del_by_context(SilcIDCache cache, void *context,
+                                         void *app_context);
+
+
    +DESCRIPTION + +
    
+    Deletes cachen entry by the user specified context.  Returns TRUE
+    if the entry was deleted.  The destructor will be called for the
+    entry.  The `app_context' is delivered to the destructor.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_del_by_id.html b/docs/toolkit/manual/silcidcache-silc_idcache_del_by_id.html new file mode 100644 index 0000000..33ca362 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_del_by_id.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_del_by_id

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_del_by_id(SilcIDCache cache, void *id,
+                                    void *app_context);
+
+
    +DESCRIPTION + +
    
+    Delete cache entry by ID.  Returns TRUE if the entry was deleted.
+    The destructor will be called for the entry.  The `app_context' is
+    delivered to the destructor.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_find_by_context.html b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_context.html new file mode 100644 index 0000000..d33dbf0 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_context.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_find_by_context

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_find_by_context(SilcIDCache cache, void *context,
+                                      SilcIDCacheEntry *ret);
+
+
    +DESCRIPTION + +
    
+    Find cache entry by user specified context. Returns TRUE if the
+    entry was found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_find_by_id.html b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_id.html new file mode 100644 index 0000000..4346373 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_id.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_find_by_id

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_find_by_id(SilcIDCache cache, void *id,
+                                     SilcList *ret_list);
+
+
    +DESCRIPTION + +
    
+    Find ID Cache entry by ID.  This may return multiple entries.
+    The entires are returned into the `ret_list' SilcList context.
+    Returns TRUE if entry was found.
+
+
    +NOTES + +
    
+    If this function is used to find Client ID (SilcClientID), only the
+    hash portion of the Client ID is compared.  Use the function
+    silc_idcache_find_by_id_one to find exact match for Client ID (full
+    ID is compared and not only the hash).
+
+    Comparing only the hash portion of Client ID allows searching of
+    Client ID's by nickname, because the hash is based on the nickname.
+    As nicknames are not unique, multiple entries may be found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_find_by_id_one.html b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_id_one.html new file mode 100644 index 0000000..372b957 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_id_one.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_find_by_id_one

    + + +SYNOPSIS + +
    
+     SilcBool silc_idcache_find_by_id_one(SilcIDCache cache, void *id,
+                                          SilcIDCacheEntry *ret);
+
+
    +DESCRIPTION + +
    
+    Find ID Cache entry by ID.  Returns only one entry from the cache
+    and the found entry is considered to be exact match.  Returns TRUE
+    if the entry was found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_find_by_name.html b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_name.html new file mode 100644 index 0000000..228256f --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_name.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_find_by_name

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_find_by_name(SilcIDCache cache, char *name,
+                                       SilcList *ret_list);
+
+
    +DESCRIPTION + +
    
+    Find cache entries by the name associated with the ID.  This may
+    return multiple entries to the `ret_list' SilcList context.  Returns
+    TRUE if the entry was found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_find_by_name_one.html b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_name_one.html new file mode 100644 index 0000000..be10c4f --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_find_by_name_one.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_find_by_name_one

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_find_by_name_one(SilcIDCache cache, char *name,
+                                       SilcIDCacheEntry *ret);
+
+
    +DESCRIPTION + +
    
+    Find cache entry by the name associated with the ID.  This returns
+    one entry and the found entry is considered to be exact match.
+    Returns TRUE if the entry was found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_free.html b/docs/toolkit/manual/silcidcache-silc_idcache_free.html new file mode 100644 index 0000000..15189a8 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_free.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_free

    + + +SYNOPSIS + +
    
+    void silc_idcache_free(SilcIDCache cache);
+
+
    +DESCRIPTION + +
    
+    Frees ID cache context and all cache entries.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_get_all.html b/docs/toolkit/manual/silcidcache-silc_idcache_get_all.html new file mode 100644 index 0000000..a9540e6 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_get_all.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_get_all

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_get_all(SilcIDCache cache, SilcList *ret_list);
+
+
    +DESCRIPTION + +
    
+    Returns all cache entries into the SilcList `ret_list' pointer.  Each
+    entry in the list is SilcIDCacheEntry.  Returns FALSE if the cache
+    is empty.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_move.html b/docs/toolkit/manual/silcidcache-silc_idcache_move.html new file mode 100644 index 0000000..6922931 --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_move.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_move

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_move(SilcIDCache from_cache, SilcIDCache to_cache,
+                               SilcIDCacheEntry entry);
+
+
    +DESCRIPTION + +
    
+    Moves the ID cache entry indicated by `entry' from the `from_cache'
+    to `to_cache'.  After this returns TRUE the `entry' is available only
+    from the `to_cache'.  Return FALSE if `entry' is not in `from_cache'
+    or system is out of memory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_update.html b/docs/toolkit/manual/silcidcache-silc_idcache_update.html new file mode 100644 index 0000000..6cd175d --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_update.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_update

    + + +SYNOPSIS + +
    
+    SilcBool silc_idcache_update(SilcIDCache cache, SilcIDCacheEntry entry,
+                                 void *new_id, char *new_name,
+                                 SilcBool free_old_name);
+
+
    +DESCRIPTION + +
    
+    Updates cache `entry' with new values.  If the `new_id' is non-NULL
+    then the new value will be copied over the old value in the `entry'
+    unless the ID doesn't exist, when the `new_id' will be stored in `entry'.
+    If the `new_name' is non-NULL then the `entry' will be updated with
+    `new_name'.  The caller is responsible of freeing the old name if it
+    was updated with new one.  The old ID value does not need to be freed
+    as the new value is copied over the old value.  If the `free_old_name'
+    is TRUE the library will free the old name from the entry.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache-silc_idcache_update_by_context.html b/docs/toolkit/manual/silcidcache-silc_idcache_update_by_context.html new file mode 100644 index 0000000..5f795ad --- /dev/null +++ b/docs/toolkit/manual/silcidcache-silc_idcache_update_by_context.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_idcache_update_by_context

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_idcache_update_by_context(SilcIDCache cache, void *context,
+                                   void *new_id, char *new_name,
+                                   SilcBool free_old_name);
+
+
    +DESCRIPTION + +
    
+    Same as silc_idcache_update but finds the corrent ID cache entry by
+    the `context' added to the ID cache.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC ID Cache Interface
    +SilcIDCacheEntry
    +SilcIDCache
    +SilcIDCacheDestructor
    +silc_idcache_alloc
    +silc_idcache_free
    +silc_idcache_add
    +silc_idcache_del
    +silc_idcache_del_by_id
    +silc_idcache_del_by_context
    +silc_idcache_update
    +silc_idcache_update_by_context
    +silc_idcache_move
    +silc_idcache_get_all
    +silc_idcache_find_by_id
    +silc_idcache_find_by_id_one
    +silc_idcache_find_by_context
    +silc_idcache_find_by_name
    +silc_idcache_find_by_name_one
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache.html b/docs/toolkit/manual/silcidcache.html new file mode 100644 index 0000000..88be316 --- /dev/null +++ b/docs/toolkit/manual/silcidcache.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcidcache.html + + + + +
    + +SILC ID Cache Interface
    Header: silcidcache.h

    + + +DESCRIPTION + +
    
+ SILC ID Cache is an cache for all kinds of ID's used in the SILC
+ protocol.  Application can save here the ID's it uses and the interface
+ provides fast retrieval of the ID's from the cache.
+
+ SILC ID Cache is not thread-safe.  If the same cache context must be
+ used in multithreaded environment concurrency control must be employed.
+
+
  • SilcIDCacheEntry +
  • SilcIDCache +
  • SilcIDCacheDestructor +
  • silc_idcache_alloc +
  • silc_idcache_free +
  • silc_idcache_add +
  • silc_idcache_del +
  • silc_idcache_del_by_id +
  • silc_idcache_del_by_context +
  • silc_idcache_update +
  • silc_idcache_update_by_context +
  • silc_idcache_move +
  • silc_idcache_get_all +
  • silc_idcache_find_by_id +
  • silc_idcache_find_by_id_one +
  • silc_idcache_find_by_context +
  • silc_idcache_find_by_name +
  • silc_idcache_find_by_name_one + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcidcache.xref b/docs/toolkit/manual/silcidcache.xref new file mode 100644 index 0000000..d6e1e3d --- /dev/null +++ b/docs/toolkit/manual/silcidcache.xref @@ -0,0 +1,25 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcidcache.h" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 0 + "SILC ID Cache Interface" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 1 + "SilcIDCacheEntry" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 5 + "SilcIDCache" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 5 + "SilcIDCacheDestructor" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_alloc" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_free" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_add" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_del" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_del_by_id" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_del_by_context" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_update" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_update_by_context" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_move" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_get_all" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_find_by_id" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_find_by_id_one" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_find_by_context" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_find_by_name" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + "silc_idcache_find_by_name_one" "/home/priikone/silc1/doc/toolkit/silcidcache.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silclist-SILC_LIST_END.html b/docs/toolkit/manual/silclist-SILC_LIST_END.html new file mode 100644 index 0000000..0c44eca --- /dev/null +++ b/docs/toolkit/manual/silclist-SILC_LIST_END.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_LIST_END

    + + +NAME + +
    
+    #define SILC_LIST_END ...
+
+
    +DESCRIPTION + +
    
+    Functions return this when the list is invalid or when traversing
+    the list there is no more entires in the list.
+
+
    +SOURCE + +
        #define SILC_LIST_END NULL
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-SilcList.html b/docs/toolkit/manual/silclist-SilcList.html new file mode 100644 index 0000000..2788787 --- /dev/null +++ b/docs/toolkit/manual/silclist-SilcList.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcList

    + + +NAME + +
    
+    typedef struct { ... } SilcList;
+
+
    +DESCRIPTION + +
    
+    This is the SilcList context, and is initialized by calling the
+    function silc_list_init.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_add.html b/docs/toolkit/manual/silclist-silc_list_add.html new file mode 100644 index 0000000..ac2c0bb --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_add.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_add

    + + +SYNOPSIS + +
    
+    #define silc_list_add(list, entry) ...
+
+
    +DESCRIPTION + +
    
+    Adds new entry indicated by `entry' to the end of the list indicated
+    by `list'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_count.html b/docs/toolkit/manual/silclist-silc_list_count.html new file mode 100644 index 0000000..9df6417 --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_count.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_count

    + + +SYNOPSIS + +
    
+    #define silc_list_count(list) ...
+
+
    +DESCRIPTION + +
    
+    Returns the number of entries in the list indicated by `list'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_del.html b/docs/toolkit/manual/silclist-silc_list_del.html new file mode 100644 index 0000000..cf48679 --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_del.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_del

    + + +SYNOPSIS + +
    
+    #define silc_list_del(list, entry) ...
+
+
    +DESCRIPTION + +
    
+    Remove entry indicated by `entry' from the list indicated by `list'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_end.html b/docs/toolkit/manual/silclist-silc_list_end.html new file mode 100644 index 0000000..79e022d --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_end.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_end

    + + +SYNOPSIS + +
    
+    #define silc_list_end(list) ...
+
+
    +DESCRIPTION + +
    
+    Sets the end of the list.  This prepares the list for traversing
+    the entries from the end of the list towards start of the list.
+
+
    +NOTES + +
    
+    You can use this call only if you initialized the list with
+    silc_list_init_prev.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_get.html b/docs/toolkit/manual/silclist-silc_list_get.html new file mode 100644 index 0000000..543071d --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_get.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_get

    + + +SYNOPSIS + +
    
+    #define silc_list_get(list) ...
+
+
    +DESCRIPTION + +
    
+    Returns the current entry from the list indicated by `list' and
+    moves the list pointer forward so that calling this next time will
+    return the next entry from the list.  This can be used to traverse
+    the list.  Returns SILC_LIST_END when the entire list has been
+    tarversed and no additional entries exist in the list. Later,
+    silc_list_start (or silc_list_end) must be called again when
+    re-starting the list tarversing.
+
+
    +EXAMPLE + +
    
+    // Traverse the list from the beginning to the end
+    silc_list_start(list);
+    while ((entry = silc_list_get(list)) != SILC_LIST_END) {
+      ...
+    }
+
+    // Traverse the list from the end to the beginning
+    silc_list_end(list);
+    while ((entry = silc_list_get(list)) != SILC_LIST_END) {
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_init.html b/docs/toolkit/manual/silclist-silc_list_init.html new file mode 100644 index 0000000..aad7628 --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_init.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_init

    + + +SYNOPSIS + +
    
+    #define silc_list_init(list, type, nextfield) ...
+
+
    +DESCRIPTION + +
    
+    This macro initializes the SilcList list.  The `list' is the defined
+    list, second argument is the structure of the entries in the list,
+    and last argument is the pointer in the structure that is used
+    as next list members.  When using SilcList you must not touch the
+    structure member pointers manually.  If your list has also a prev
+    pointer should use silc_list_init_prev instead of this call if
+    you need to be able traverse the list backwards as well.
+
+
    +EXAMPLE + +
    
+    struct SilcInternalEntryStruct {
+      char *dummy;
+      struct SilcInternalEntryStruct *next; // The list member pointer
+    };
+
+    SilcList list;
+    silc_list_init(list, struct SilcInternalEntryStruct, next);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_init_prev.html b/docs/toolkit/manual/silclist-silc_list_init_prev.html new file mode 100644 index 0000000..63f5caf --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_init_prev.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_init_prev

    + + +SYNOPSIS + +
    
+    #define silc_list_init_prev(list, type, nextfield, prevfield) ...
+
+
    +DESCRIPTION + +
    
+    This macro initializes the SilcList list.  The `list' is the defined
+    list, second argument is the structure of the entries in the list,
+    and last two arguments are the pointers in the structure that is used
+    as next and prev list members.  When using SilcList you must not
+    touch the structure member pointers manually.
+
+    Having both next and prev pointers makes it possible to traverse
+    list from both ends of the list (from start to end, and from end
+    to start).
+
+
    +EXAMPLE + +
    
+    struct SilcInternalEntryStruct {
+      char *dummy;
+      struct SilcInternalEntryStruct *next; // The list member pointer
+      struct SilcInternalEntryStruct *prev; // The list member pointer
+    };
+
+    SilcList list;
+    silc_list_init_prev(list, struct SilcInternalEntryStruct, next, prev);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_insert.html b/docs/toolkit/manual/silclist-silc_list_insert.html new file mode 100644 index 0000000..54f99f0 --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_insert.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_insert

    + + +SYNOPSIS + +
    
+    #define silc_list_insert(list, current, entry) ...
+
+
    +DESCRIPTION + +
    
+    Insert new entry indicated by `entry' after the entry `current'
+    to the list indicated by `list'.  If `current' is NULL, then the
+    `entry' is added at the head of the list.  Use the silc_list_add
+    to add at the end of the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist-silc_list_start.html b/docs/toolkit/manual/silclist-silc_list_start.html new file mode 100644 index 0000000..16ae0fc --- /dev/null +++ b/docs/toolkit/manual/silclist-silc_list_start.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_list_start

    + + +SYNOPSIS + +
    
+    #define silc_list_start(list) ...
+
+
    +DESCRIPTION + +
    
+    Sets the start of the list.  This prepares the list for traversing
+    the entries from the start of the list towards end of the list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC List Interface
    +SilcList
    +SILC_LIST_END
    +silc_list_init
    +silc_list_init_prev
    +silc_list_count
    +silc_list_start
    +silc_list_end
    +silc_list_add
    +silc_list_insert
    +silc_list_del
    +silc_list_get
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist.html b/docs/toolkit/manual/silclist.html new file mode 100644 index 0000000..38461e4 --- /dev/null +++ b/docs/toolkit/manual/silclist.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silclist.html + + + + +
    + +SILC List Interface
    Header: silclist.h

    + + +DESCRIPTION + +
    
+ Implementation of the SilcList interface.  This interface provides
+ simple linked list.  This interface does not allocate any memory.
+
+ SILC List is not thread-safe.  If the same list context must be used
+ in multithreaded environment concurrency control must be employed.
+
+
  • SilcList +
  • SILC_LIST_END +
  • silc_list_init +
  • silc_list_init_prev +
  • silc_list_count +
  • silc_list_start +
  • silc_list_end +
  • silc_list_add +
  • silc_list_insert +
  • silc_list_del +
  • silc_list_get + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclist.xref b/docs/toolkit/manual/silclist.xref new file mode 100644 index 0000000..02ff122 --- /dev/null +++ b/docs/toolkit/manual/silclist.xref @@ -0,0 +1,18 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silclist.h" "/home/priikone/silc1/doc/toolkit/silclist.html" 0 + "SILC List Interface" "/home/priikone/silc1/doc/toolkit/silclist.html" 1 + "SilcList" "/home/priikone/silc1/doc/toolkit/silclist.html" 5 + "SILC_LIST_END" "/home/priikone/silc1/doc/toolkit/silclist.html" 8 + "silc_list_init" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_init_prev" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_count" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_start" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_end" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_add" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_insert" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_del" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + "silc_list_get" "/home/priikone/silc1/doc/toolkit/silclist.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silclog-SILC_ASSERT.html b/docs/toolkit/manual/silclog-SILC_ASSERT.html new file mode 100644 index 0000000..e14ed30 --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_ASSERT.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ASSERT

    + + +NAME + +
    
+    #define SILC_ASSERT(experssion)
+
+
    +DESCRIPTION + +
    
+    Assert macro that prints error message to stderr and calls abort()
+    if the `expression' is false (ie. compares equal to zero).  If
+    SILC_DEBUG is not defined this macro has no effect.
+
+
    +SOURCE + +
        #if defined(SILC_DEBUG)
+    #define SILC_ASSERT(expr) assert((expr))
+    #else
+    #define SILC_ASSERT(expr) do { } while(0)
+    #endif /* SILC_DEBUG */
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SILC_LOG_DEBUG.html b/docs/toolkit/manual/silclog-SILC_LOG_DEBUG.html new file mode 100644 index 0000000..d68a308 --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_LOG_DEBUG.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_LOG_DEBUG

    + + +NAME + +
    
+    #define SILC_LOG_DEBUG(...)
+
+
    +DESCRIPTION + +
    
+    This is a special wrapper to the debugging output (usually stderr).
+    The standard behaviour is the same as SILC_LOG_INFO, with the difference
+    that this macro also depends on the global define SILC_DEBUG.
+
+    Undefining SILC_DEBUG causes these functions to be defined to an empty
+    value, thus removing all debug logging calls from the compiled
+    application.
+
+
    +SOURCE + +
        #if defined(SILC_DEBUG)
+    #define SILC_LOG_DEBUG(fmt) silc_log_output_debug(__FILE__,     \
+                                    __FUNCTION__,                   \
+                                    __LINE__,                       \
+                                    silc_format fmt)
+    #define SILC_NOT_IMPLEMENTED(string)                                    \
+      SILC_LOG_INFO(("*********** %s: NOT IMPLEMENTED YET", string));
+    #else
+    #define SILC_LOG_DEBUG(fmt) do { } while(0)
+    #define SILC_NOT_IMPLEMENTED(string) do { } while(0)
+    #endif  /* SILC_DEBUG */
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SILC_LOG_ERROR.html b/docs/toolkit/manual/silclog-SILC_LOG_ERROR.html new file mode 100644 index 0000000..6b6385c --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_LOG_ERROR.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_LOG_ERROR

    + + +NAME + +
    
+    #define SILC_LOG_ERROR(...)
+
+
    +DESCRIPTION + +
    
+    Wrapper to the ERROR logging channel.
+    Please see the SILC_LOG_INFO macro.
+
+
    +SEE ALSO + +
        SILC_LOG_INFO
+
+
    +SOURCE + +
        #define SILC_LOG_ERROR(fmt) silc_log_output(SILC_LOG_ERROR, silc_format fmt)
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SILC_LOG_FATAL.html b/docs/toolkit/manual/silclog-SILC_LOG_FATAL.html new file mode 100644 index 0000000..e19e29b --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_LOG_FATAL.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_LOG_FATAL

    + + +NAME + +
    
+    #define SILC_LOG_FATAL(...)
+
+
    +DESCRIPTION + +
    
+    Wrapper to the FATAL logging channel.
+    Please see the SILC_LOG_INFO macro.
+
+
    +SEE ALSO + +
        SILC_LOG_INFO
+
+
    +SOURCE + +
        #define SILC_LOG_FATAL(fmt) silc_log_output(SILC_LOG_FATAL, silc_format fmt)
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SILC_LOG_HEXDUMP.html b/docs/toolkit/manual/silclog-SILC_LOG_HEXDUMP.html new file mode 100644 index 0000000..cf0252d --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_LOG_HEXDUMP.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_LOG_HEXDUMP

    + + +NAME + +
    
+    #define SILC_LOG_HEXDUMP(...)
+
+
    +DESCRIPTION + +
    
+    This is a special wrapper to the hexdump output function.  This macro
+    behaves slightly differently from other logging wrappers.
+    The first parameter, is composed by a group of parameters delimited by
+    parenthesis.
+    The second parameter is a `char *' pointer pointing to the beginning
+    of the memory section that should be hexdumped, and the third parameter
+    is the length of this memory section.
+    Undefining the global SILC_DEBUG define causes these functions to be
+    defined to an empty value, thus removing all debug logging calls from
+    the compiled application.
+    This macro is also affected by the global variable silc_debug_hexdump.
+
+
    +EXAMPLE + +
    
+    SILC_LOG_HEXDUMP(("Outgoing packet [%d], len %d", pckt->seq, pckt->len),
+                     pckt->data, pckt->datalen);
+
+
    +SOURCE + +
        #if defined(SILC_DEBUG)
+    #define SILC_LOG_HEXDUMP(fmt, data, len) silc_log_output_hexdump(__FILE__, \
+                                    __FUNCTION__,                              \
+                                    __LINE__,                                  \
+                                    (void *)(data), (len),                     \
+                                    silc_format fmt)
+    #else
+    #define SILC_LOG_HEXDUMP(fmt, data, len) do { } while(0)
+    #endif  /* SILC_DEBUG */
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SILC_LOG_INFO.html b/docs/toolkit/manual/silclog-SILC_LOG_INFO.html new file mode 100644 index 0000000..64a6ecb --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_LOG_INFO.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_LOG_INFO

    + + +NAME + +
    
+    #define SILC_LOG_INFO(...)
+
+
    +DESCRIPTION + +
    
+    This macro is a wrapper to the main logging function.
+    It supports variable argument list formatting, and *automatically*
+    appends newline at the end of the string.
+
+
    +NOTES + +
    
+    This macro requires double parenthesis to ensure that the VA list
+    formatting would work correctly.
+
+
    +EXAMPLE + +
    
+    SILC_LOG_INFO(("Today i feel %s", core->mood));
+
+
    +SOURCE + +
        #define SILC_LOG_INFO(fmt) silc_log_output(SILC_LOG_INFO, silc_format fmt)
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SILC_LOG_WARNING.html b/docs/toolkit/manual/silclog-SILC_LOG_WARNING.html new file mode 100644 index 0000000..632c287 --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_LOG_WARNING.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_LOG_WARNING

    + + +NAME + +
    
+    #define SILC_LOG_WARNING(...)
+
+
    +DESCRIPTION + +
    
+    Wrapper to the WARNING logging channel.
+    Please see the SILC_LOG_INFO macro.
+
+
    +SEE ALSO + +
        SILC_LOG_INFO
+
+
    +SOURCE + +
        #define SILC_LOG_WARNING(fmt) silc_log_output(SILC_LOG_WARNING, silc_format fmt)
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SILC_VERIFY.html b/docs/toolkit/manual/silclog-SILC_VERIFY.html new file mode 100644 index 0000000..8e5ce80 --- /dev/null +++ b/docs/toolkit/manual/silclog-SILC_VERIFY.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_VERIFY

    + + +NAME + +
    
+    #define SILC_VERIFY(experssion)
+
+
    +DESCRIPTION + +
    
+    Verification macro that prints error message to stderr and calls
+    abort() if the `expression' is false (ie. compares equal to zero)
+    on debug builds (SILC_DEBUG defined), and prints error message to
+    stderr on release builds (SILC_DEBUG undefined) but does not abort().
+    This macro is always compiled even if debugging (SILC_DEBUG) is not
+    defined.
+
+
    +SOURCE + +
        #if defined(SILC_DEBUG)
+    #define SILC_VERIFY(expr) assert((expr))
+    #else
+    #define SILC_VERIFY(expr)                                               \
+      if (!(expr))                                                          \
+        SILC_LOG_ERROR(("SILC_VERIFY %s:%d", __FUNCTION__, __LINE__))
+    #endif /* SILC_DEBUG */
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SilcLogCb.html b/docs/toolkit/manual/silclog-SilcLogCb.html new file mode 100644 index 0000000..df5cb00 --- /dev/null +++ b/docs/toolkit/manual/silclog-SilcLogCb.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcLogCb

    + + +SYNOPSIS + +
    
+    typedef SilcBool (*SilcLogCb)(SilcLogType type, char *message,
+                                  void *context);
+
+
    +DESCRIPTION + +
    
+    The logging custom callback function.  The `type' is the channel ID
+    that triggered the event, which allows you to use the same callback
+    function for multiple logging channels.
+
+    The `message' parameter points to a null-terminated buffer containing
+    the received message, while `context' is the caller-specified context.
+    The message must not be modified or freed by the callback function.
+    If the function returns TRUE, SilcLog will assume the message was
+    handled and won't run its default handler.
+
+
    +SEE ALSO + +
        silc_log_set_callback
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SilcLogDebugCb.html b/docs/toolkit/manual/silclog-SilcLogDebugCb.html new file mode 100644 index 0000000..0169b99 --- /dev/null +++ b/docs/toolkit/manual/silclog-SilcLogDebugCb.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcLogDebugCb

    + + +SYNOPSIS + +
    
+    typedef SilcBool (*SilcLogDebugCb)(char *file, char *function, int line,
+                                       char *message, void *context);
+
+
    +DESCRIPTION + +
    
+    The debug logging callback function.  The default behaviour is to
+    output messages to stderr.  `file', `function', and `line' are the
+    corresponding offsets in the source files.  `message' points to a
+    null-terminated buffer containing the debugging message, and `context'
+    is the caller-specified context.
+
+    The message must not be modified or freed by the callback function.
+    If the function returns TRUE, SilcLog will assume the message as handled
+    and won't run its default handler.
+
+
    +SEE ALSO + +
        silc_debug, silc_log_set_debug_callbacks
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SilcLogHexdumpCb.html b/docs/toolkit/manual/silclog-SilcLogHexdumpCb.html new file mode 100644 index 0000000..0c2627a --- /dev/null +++ b/docs/toolkit/manual/silclog-SilcLogHexdumpCb.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcLogHexdumpCb

    + + +SYNOPSIS + +
    
+    typedef SilcBool
+    (*SilcDebugHexdumpCb)(char *file, char *function, int line,
+                          unsigned char *data,
+                          SilcUInt32 data_len,
+                          char *message, void *context;
+
+
    +DESCRIPTION + +
    
+    The hexdump logging callback function.  The default behaviour is to
+    print a formatted hexdump to stderr, and is commonly what you would
+    like it to be.  `file', `function', and `line' are the corresponding
+    offsets in the source files.  `data' is the begin of the buffer that
+    should be hexdumped, which is `data_len' bytes long.
+
+    The `message' parameter points to a null-terminated buffer containing
+    the received message, while `context' is the caller-specified context.
+    The message must not be modified or freed by the callback function.
+    If the function returns TRUE, SilcLog will assume the message as handled
+    and won't run its default handler.
+
+
    +SEE ALSO + +
        silc_debug_hexdump, silc_log_set_debug_callbacks
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-SilcLogType.html b/docs/toolkit/manual/silclog-SilcLogType.html new file mode 100644 index 0000000..613638f --- /dev/null +++ b/docs/toolkit/manual/silclog-SilcLogType.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcLogType

    + + +NAME + +
    
+    typedef enum { ... } SilcLogType;
+
+
    +DESCRIPTION + +
    
+    The log type.  This can be given to various silc_log_* routines.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_LOG_INFO       = 1,      /* Generic info */
+      SILC_LOG_WARNING    = 2,      /* Warnings and non-critical failures */
+      SILC_LOG_ERROR      = 3,      /* Generic error and critical failure */
+      SILC_LOG_FATAL      = 4,      /* Fatal error */
+    } SilcLogType;
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_debug.html b/docs/toolkit/manual/silclog-silc_log_debug.html new file mode 100644 index 0000000..e54a7e7 --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_debug.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Variable silc_log_debug

    + + +NAME + +
    
+    void silc_log_debug(SilcBool enable);
+
+
    +DESCRIPTION + +
    
+    If `enable' is set to FALSE, debugging functions won't procude any
+    output and if set to TRUE prints debug messages to stderr.  Default
+    is FALSE.
+
+
    +SEE ALSO + +
        SILC_LOG_DEBUG
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_debug_hexdump.html b/docs/toolkit/manual/silclog-silc_log_debug_hexdump.html new file mode 100644 index 0000000..e13017c --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_debug_hexdump.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Variable silc_log_debug_hexdump

    + + +NAME + +
    
+    void silc_log_debug_hexdump(SilcBool enable);
+
+
    +DESCRIPTION + +
    
+    If `enable' is set to FALSE, debugging functions won't produce
+    any output anf if set to TRUE prints hexdump debug message to
+    stderr.  Default is FALSE.
+
+
    +SEE ALSO + +
        SILC_LOG_HEXDUMP
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_flush_all.html b/docs/toolkit/manual/silclog-silc_log_flush_all.html new file mode 100644 index 0000000..f801c6e --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_flush_all.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_flush_all

    + + +SYNOPSIS + +
    
+    void silc_log_flush_all();
+
+
    +DESCRIPTION + +
    
+    Forces flushing for all logging channels.  This should be called for
+    example after receiving special signals.
+
+
    +SEE ALSO + +
        silc_log_quick
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_flushdelay.html b/docs/toolkit/manual/silclog-silc_log_flushdelay.html new file mode 100644 index 0000000..6d7d26a --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_flushdelay.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_flushdelay

    + + +NAME + +
    
+    void silc_log_flushdelay(SilcUInt32 flushdelay);
+
+
    +DESCRIPTION + +
    
+    Sets the logfiles flushing delay in seconds.  Default is 300 seconds.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_get_file.html b/docs/toolkit/manual/silclog-silc_log_get_file.html new file mode 100644 index 0000000..e64bc77 --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_get_file.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_get_file

    + + +SYNOPSIS + +
    
+    char *silc_log_get_file(SilcLogType type);
+
+
    +DESCRIPTION + +
    
+    Returns the current logging file for the channel `type'.
+    If there has been an error during the opening of this channel, NULL
+    is returned, even if the file has been previously set with
+    silc_log_set_file().
+
+    The returned pointer points to internally allocated storage and must
+    not be freed, modified or stored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_quick.html b/docs/toolkit/manual/silclog-silc_log_quick.html new file mode 100644 index 0000000..80f116f --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_quick.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_quick

    + + +NAME + +
    
+    void silc_log_quick(SilcBool enable);
+
+
    +DESCRIPTION + +
    
+    SilcLog makes use of libc stream buffering output, which means that it
+    saves HD activity by buffering the logging messages and writing them
+    all together every some minutes (default is 5 minutes).
+
+    Setting `enable' to TRUE will force SilcLog to write messages to the
+    filesystem as soon as they are received. This increases the CPU activity
+    notably on bigger servers, but reduces memory usage.
+
+    If you want to change the logging style on-the-fly, make sure to call
+    silc_log_flush_all() after setting `enable'  to TRUE.
+
+    Default is FALSE.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_reset_all.html b/docs/toolkit/manual/silclog-silc_log_reset_all.html new file mode 100644 index 0000000..b85c1d8 --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_reset_all.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_reset_all

    + + +SYNOPSIS + +
    
+    void silc_log_reset_all();
+
+
    +DESCRIPTION + +
    
+    Forces all logging channels to close and reopen their streams.  Useful
+    for example after a SIGHUP signal.
+
+    Please note that this function could generate some warning messages if
+    one or more logging channels point to an illegal filename.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_reset_callbacks.html b/docs/toolkit/manual/silclog-silc_log_reset_callbacks.html new file mode 100644 index 0000000..f773bde --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_reset_callbacks.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_reset_callbacks

    + + +SYNOPSIS + +
    
+    void silc_log_reset_callbacks();
+
+
    +DESCRIPTION + +
    
+    Removes all logging callbacks for normal channels.  This function does
+    NOT remove callbacks for debugging channels (debug and hexdump), you
+    rather need to call silc_log_set_debug_callbacks() with NULL callbacks.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_reset_debug_callbacks.html b/docs/toolkit/manual/silclog-silc_log_reset_debug_callbacks.html new file mode 100644 index 0000000..c6a1d36 --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_reset_debug_callbacks.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_reset_debug_callbacks

    + + +SYNOPSIS + +
    
+    void silc_log_reset_debug_callbacks();
+
+
    +DESCRIPTION + +
    
+    Resets debug callbacks set with silc_log_set_debug_callbacks.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_set_callback.html b/docs/toolkit/manual/silclog-silc_log_set_callback.html new file mode 100644 index 0000000..682cdd9 --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_set_callback.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_set_callback

    + + +SYNOPSIS + +
    
+    void silc_log_set_callback(SilcLogType type, SilcLogCb cb,
+                               void *context);
+
+
    +DESCRIPTION + +
    
+    Set `cb' as the default callback function for the logging channel
+    `type'.  When SilcLog receives a message for this channel, it will
+    trigger the callback function.  If the callback function returns TRUE
+    SilcLog will assume the input as handled and won't run its default
+    handler.
+
+    You can disable/remove a callback by setting it to NULL or calling the
+    function silc_log_reset_callbacks.  If set, the callback function
+    must be in the form described by SilcLogCb.
+
+
    +SEE ALSO + +
        silc_log_reset_callbacks
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_set_debug_callbacks.html b/docs/toolkit/manual/silclog-silc_log_set_debug_callbacks.html new file mode 100644 index 0000000..58439ec --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_set_debug_callbacks.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_set_debug_callbacks

    + + +SYNOPSIS + +
    
+    void silc_log_set_debug_callbacks(SilcLogDebugCb debug_cb,
+                                      void *debug_context,
+                                      SilcLogHexdumpCb hexdump_cb,
+                                      void *hexdump_context);
+
+
    +DESCRIPTION + +
    
+    Sets `debug_cb' as the the default callback function for the debug
+    output, that will be called with the `debug_context' parameter.
+    When SilcLog receives a debug message, it will trigger the callback
+    function.  If the callback function returns TRUE SilcLog will assume
+    the input as handled and won't run its default handler.  The `hexdump_cb'
+    and `hexdump_context' works the same way, except that they are referred
+    to SILC_LOG_HEXDUMP requests.
+
+    You can disable/remove a callback by setting it to NULL.  If set, each
+    callback function must be either in the form described by SilcLogDebugCb
+    or SilcLogHexdumpCb.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_set_debug_string.html b/docs/toolkit/manual/silclog-silc_log_set_debug_string.html new file mode 100644 index 0000000..69cb444 --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_set_debug_string.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_set_debug_string

    + + +SYNOPSIS + +
    
+    void silc_log_set_debug_string(const char *debug_string);
+
+
    +DESCRIPTION + +
    
+    Sets `debug_string' as the regexp string for filtering debugging
+    output.  The string is copied and it can be modified/destroyed after
+    this function call.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_set_file.html b/docs/toolkit/manual/silclog-silc_log_set_file.html new file mode 100644 index 0000000..6855e6e --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_set_file.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_set_file

    + + +SYNOPSIS + +
    
+    SilcBool silc_log_set_file(SilcLogType type, char *filename,
+                           SilcUInt32 maxsize,
+                           SilcSchedule scheduler);
+
+
    +DESCRIPTION + +
    
+    Sets `filename', which can be maximum `maxsize' bytes long, as the new
+    logging file for the channel `type'.  If you specify an illegal filename
+    a warning message is printed and FALSE is returned.  In this case
+    logging settings are not changed.
+
+    You can disable logging for a channel by specifying NULL filename, the
+    maxsize in this case is not important.  The `scheduler' parameter is
+    needed by the internal logging to allow buffered output and thus to
+    save HD activity.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog-silc_log_timestamp.html b/docs/toolkit/manual/silclog-silc_log_timestamp.html new file mode 100644 index 0000000..52cdf02 --- /dev/null +++ b/docs/toolkit/manual/silclog-silc_log_timestamp.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_log_timestamp

    + + +NAME + +
    
+    void silc_log_timestamp(SilcBool enable);
+
+
    +DESCRIPTION + +
    
+    Use timestamp in log messages.  Set `enable' to TRUE to enable
+    timestamp and to FALSE to disable it.  Default is TRUE.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Logging Interface
    +SilcLogType
    +SilcLogCb
    +SilcLogDebugCb
    +SilcLogHexdumpCb
    +SILC_LOG_INFO
    +SILC_LOG_WARNING
    +SILC_LOG_ERROR
    +SILC_LOG_FATAL
    +SILC_LOG_DEBUG
    +SILC_LOG_HEXDUMP
    +SILC_ASSERT
    +SILC_VERIFY
    +silc_log_set_file
    +silc_log_get_file
    +silc_log_set_callback
    +silc_log_reset_callbacks
    +silc_log_flush_all
    +silc_log_reset_all
    +silc_log_set_debug_callbacks
    +silc_log_reset_debug_callbacks
    +silc_log_set_debug_string
    +silc_log_timestamp
    +silc_log_flushdelay
    +silc_log_quick
    +silc_log_debug
    +silc_log_debug_hexdump
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog.html b/docs/toolkit/manual/silclog.html new file mode 100644 index 0000000..07520b6 --- /dev/null +++ b/docs/toolkit/manual/silclog.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silclog.html + + + + +
    + +SILC Logging Interface
    Header: silclog.h

    + + +DESCRIPTION + +
    
+ The SILC logging APIs provide a powerful and easy-to-use interface to
+ the logging system and debugging output.
+
+
  • SilcLogType +
  • SilcLogCb +
  • SilcLogDebugCb +
  • SilcLogHexdumpCb +
  • SILC_LOG_INFO +
  • SILC_LOG_WARNING +
  • SILC_LOG_ERROR +
  • SILC_LOG_FATAL +
  • SILC_LOG_DEBUG +
  • SILC_LOG_HEXDUMP +
  • SILC_ASSERT +
  • SILC_VERIFY +
  • silc_log_set_file +
  • silc_log_get_file +
  • silc_log_set_callback +
  • silc_log_reset_callbacks +
  • silc_log_flush_all +
  • silc_log_reset_all +
  • silc_log_set_debug_callbacks +
  • silc_log_reset_debug_callbacks +
  • silc_log_set_debug_string +
  • silc_log_timestamp +
  • silc_log_flushdelay +
  • silc_log_quick +
  • silc_log_debug +
  • silc_log_debug_hexdump + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog.xref b/docs/toolkit/manual/silclog.xref new file mode 100644 index 0000000..0deffa3 --- /dev/null +++ b/docs/toolkit/manual/silclog.xref @@ -0,0 +1,33 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silclog.h" "/home/priikone/silc1/doc/toolkit/silclog.html" 0 + "SILC Logging Interface" "/home/priikone/silc1/doc/toolkit/silclog.html" 1 + "SilcLogType" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SilcLogCb" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "SilcLogDebugCb" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "SilcLogHexdumpCb" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "SILC_LOG_INFO" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SILC_LOG_WARNING" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SILC_LOG_ERROR" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SILC_LOG_FATAL" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SILC_LOG_DEBUG" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SILC_LOG_HEXDUMP" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SILC_ASSERT" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "SILC_VERIFY" "/home/priikone/silc1/doc/toolkit/silclog.html" 8 + "silc_log_set_file" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_get_file" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_set_callback" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_reset_callbacks" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_flush_all" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_reset_all" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_set_debug_callbacks" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_reset_debug_callbacks" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_set_debug_string" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_timestamp" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_flushdelay" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_quick" "/home/priikone/silc1/doc/toolkit/silclog.html" 4 + "silc_log_debug" "/home/priikone/silc1/doc/toolkit/silclog.html" 9 + "silc_log_debug_hexdump" "/home/priikone/silc1/doc/toolkit/silclog.html" 9 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silclog_i.html b/docs/toolkit/manual/silclog_i.html new file mode 100644 index 0000000..7297a63 --- /dev/null +++ b/docs/toolkit/manual/silclog_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silclog_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silclog_i.xref b/docs/toolkit/manual/silclog_i.xref new file mode 100644 index 0000000..cb3d851 --- /dev/null +++ b/docs/toolkit/manual/silclog_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silclog_i.h" "/home/priikone/silc1/doc/toolkit/silclog_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmath-silc_math_gen_prime.html b/docs/toolkit/manual/silcmath-silc_math_gen_prime.html new file mode 100644 index 0000000..f213691 --- /dev/null +++ b/docs/toolkit/manual/silcmath-silc_math_gen_prime.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_math_gen_prime

    + + +SYNOPSIS + +
    
+    SilcBool silc_math_gen_prime(SilcMPInt *prime, SilcUInt32 bits,
+                                 SilcBool verbose, SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Find appropriate prime. It generates a number by taking random bytes.
+    It then tests the number that it's not divisible by any of the small
+    primes and then it performs Fermat's prime test. I thank Rieks Joosten
+    (r.joosten@pijnenburg.nl) for such a good help with prime tests.
+
+    If argument verbose is TRUE this will display some status information
+    about the progress of generation.  If the `rng' is NULL then global
+    RNG is used, if non-NULL then `rng' is used to generate the random
+    number number.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Math Interface
    +silc_math_gen_prime
    +silc_math_prime_test
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmath-silc_math_prime_test.html b/docs/toolkit/manual/silcmath-silc_math_prime_test.html new file mode 100644 index 0000000..348716b --- /dev/null +++ b/docs/toolkit/manual/silcmath-silc_math_prime_test.html @@ -0,0 +1,214 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_math_prime_test

    + + +SYNOPSIS + +
    
+    int silc_math_prime_test(SilcMPInt *p);
+
+
    +DESCRIPTION + +
    
+    Performs primality testings for given number. Returns TRUE if the
+    number is probably a prime.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Math Interface
    +silc_math_gen_prime
    +silc_math_prime_test
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmath.html b/docs/toolkit/manual/silcmath.html new file mode 100644 index 0000000..8787285 --- /dev/null +++ b/docs/toolkit/manual/silcmath.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmath.html + + + + +
    + +SILC Math Interface
    Header: silcmath.h

    + + +DESCRIPTION + +
    
+ SILC Math interface includes various utility functions such as
+ prime generation, and conversion routines. See the silcmp.h for the
+ SILC MP interface.
+
+
  • silc_math_gen_prime +
  • silc_math_prime_test + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmath.xref b/docs/toolkit/manual/silcmath.xref new file mode 100644 index 0000000..1ed5830 --- /dev/null +++ b/docs/toolkit/manual/silcmath.xref @@ -0,0 +1,9 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmath.h" "/home/priikone/silc1/doc/toolkit/silcmath.html" 0 + "SILC Math Interface" "/home/priikone/silc1/doc/toolkit/silcmath.html" 1 + "silc_math_gen_prime" "/home/priikone/silc1/doc/toolkit/silcmath.html" 4 + "silc_math_prime_test" "/home/priikone/silc1/doc/toolkit/silcmath.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmathlib.html b/docs/toolkit/manual/silcmathlib.html new file mode 100644 index 0000000..bec27ab --- /dev/null +++ b/docs/toolkit/manual/silcmathlib.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Math Library +
    +Directory: lib/silcmath/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Math Library provides arbitrary precision artichmetic routines for +public key cryptosystems, prime number generation routines, and other +math utility functions for applications. + +

    + +
  • SILC MP Interface +
  • SILC Math Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_calloc.html b/docs/toolkit/manual/silcmemory-silc_calloc.html new file mode 100644 index 0000000..7204e52 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_calloc.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_calloc

    + + +SYNOPSIS + +
    
+    void *silc_calloc(size_t items, size_t size);
+
+
    +DESCRIPTION + +
    
+    Allocates memory of for an array of `items' elements of `size' bytes
+    and returns pointer to the allocated memory area.  The memory area is
+    also zeroed.  Free the memory by calling silc_free.  Returns NULL on
+    error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_free.html b/docs/toolkit/manual/silcmemory-silc_free.html new file mode 100644 index 0000000..2d3fa41 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_free.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_free

    + + +SYNOPSIS + +
    
+    void silc_free(void *ptr);
+
+
    +DESCRIPTION + +
    
+    Frees the memory area indicated by the `ptr'. If `ptr' is NULL no
+    operation is performed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_malloc.html b/docs/toolkit/manual/silcmemory-silc_malloc.html new file mode 100644 index 0000000..804f6f5 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_malloc.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_malloc

    + + +SYNOPSIS + +
    
+    void *silc_malloc(size_t size);
+
+
    +DESCRIPTION + +
    
+    Allocates memory of `size' bytes and returns pointer to the allocated
+    memory area.  Free the memory by calling silc_free.  Returns NULL on
+    error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_memdup.html b/docs/toolkit/manual/silcmemory-silc_memdup.html new file mode 100644 index 0000000..53f0106 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_memdup.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_memdup

    + + +SYNOPSIS + +
    
+    void *silc_memdup(const void *ptr, size_t size);
+
+
    +DESCRIPTION + +
    
+    Duplicates the memory area indicated by `ptr' which is of size
+    of `size' bytes. Returns pointer to the duplicated memory area.
+    This NULL terminates the dupped memory area by allocating `size' + 1
+    bytes, so this function can be used to duplicate strings that does
+    not have NULL termination.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_realloc.html b/docs/toolkit/manual/silcmemory-silc_realloc.html new file mode 100644 index 0000000..d86a1aa --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_realloc.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_realloc

    + + +SYNOPSIS + +
    
+    void *silc_realloc(void *ptr, size_t size);
+
+
    +DESCRIPTION + +
    
+    Change the size of the memory block indicated by `ptr' to the new
+    size of `size' bytes.  The contents of `ptr' will not be changed.
+    If `ptr' is NULL the call is equivalent to silc_malloc.  If the
+    `size' is zero (0) the call is equivalent to silc_free.  Free the
+    memory by calling silc_free.
+
+
    +NOTES + +
    
+    The pointer returned to the reallocated memory area might not be
+    same as `ptr'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_scalloc.html b/docs/toolkit/manual/silcmemory-silc_scalloc.html new file mode 100644 index 0000000..43dbda2 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_scalloc.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_scalloc

    + + +SYNOPSIS + +
    
+    void *silc_scalloc(SilcStack stack, SilcUInt32 items, SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Allocate memory block of size of `size' from the stack indicated by
+    `stack', zero the memory area and return pointer to it.  This
+    function allocates aligned memory.  Returns NULL on error.
+
+
    +NOTES + +
    
+    Be careful with this function:  do not free the returned pointer
+    explicitly and do not save the returned pointer to a permanent
+    location.
+
+    If `stack' is NULL this function calls silc_calloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_smalloc.html b/docs/toolkit/manual/silcmemory-silc_smalloc.html new file mode 100644 index 0000000..c9f50e3 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_smalloc.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_smalloc

    + + +SYNOPSIS + +
    
+    void *silc_smalloc(SilcStack stack, SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Allocate memory block of size of `size' from the stack indicated by
+    `stack' and return pointer to it.  Returns NULL on error.  This
+    function allocates aligned memory so it can be used to allocate
+    memory for structures, for example.  If you allocate strings or
+    data buffers using silc_smalloc_ua is recommended instead of this
+    function.
+
+
    +NOTES + +
    
+    Be careful with this function:  do not free the returned pointer
+    explicitly and do not save the returned pointer to a permanent
+    location.
+
+    If `stack' is NULL this function calls silc_malloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_smalloc_ua.html b/docs/toolkit/manual/silcmemory-silc_smalloc_ua.html new file mode 100644 index 0000000..77e1444 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_smalloc_ua.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_smalloc_ua

    + + +SYNOPSIS + +
    
+    void *silc_smalloc_ua(SilcStack stack, SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Allocate unaligned memory block of size of `size' from the stack
+    indicated by `stack' and return pointer to it.  Returns NULL on error.
+
+
    +NOTES + +
    
+    This function must not be used to allocate memory for structures.
+    Use this function only for strings and data buffers.
+
+    Be careful with this function:  do not free the returned pointer
+    explicitly and do not save the returned pointer to a permanent
+    location.
+
+    If `stack' is NULL this function calls silc_malloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_smemdup.html b/docs/toolkit/manual/silcmemory-silc_smemdup.html new file mode 100644 index 0000000..2097350 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_smemdup.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_smemdup

    + + +SYNOPSIS + +
    
+    void *silc_smemdup(SilcStack stack, const void *ptr, SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Duplicates the memory area indicated by `ptr' which is the size of
+    `size' bytes.  Returns pointer to the duplicated memory area.  This
+    NULL terminates the dupped memory area by allocating `size' + 1
+    bytes, so this function can be used to duplicate strings that does not
+    have NULL termination.  This function allocates aligned memory so
+    it can be used to duplicate also structures.  Returns NULL on error.
+
+
    +NOTES + +
    
+    Be careful with this function:  do not free the returned pointer
+    explicitly and do not save the returned pointer to a permanent
+    location.
+
+    If `stack' is NULL this function calls silc_memdup.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_srealloc.html b/docs/toolkit/manual/silcmemory-silc_srealloc.html new file mode 100644 index 0000000..48c8da1 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_srealloc.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_srealloc

    + + +SYNOPSIS + +
    
+    void *silc_srealloc(SilcStack stack, SilcUInt32 old_size,
+                        void *ptr, SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Change the size of the memory block indicated by `ptr' to the new
+    size of `size' bytes.  The contents of `ptr' will not be changed.
+    If `ptr' is NULL the call is equivalent to silc_smalloc.  If `size'
+    is zero (0) error will occur.  Returns NULL on error and the old
+    pointer remain intact.
+
+
    +NOTES + +
    
+    This function reallocates successfully only if the previous allocation
+    to `stack' was `ptr'.  If there was another memory allocation between
+    allocating `ptr' and this call, this routine will return NULL.  The
+    NULL is also returned if the `size' does not fit to current stack
+    and allocating new block would require slow copying of the data.  It
+    is left to the caller to decide whether to allocate new pointer and
+    copy the old data in case this function returns NULL.
+
+    This function can be used to reallocate only aligned memory allocated
+    with silc_smalloc.
+
+    If `stack' is NULL this function calls silc_realloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_srealloc_ua.html b/docs/toolkit/manual/silcmemory-silc_srealloc_ua.html new file mode 100644 index 0000000..73660a2 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_srealloc_ua.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_srealloc_ua

    + + +SYNOPSIS + +
    
+    void *silc_srealloc_ua(SilcStack stack, SilcUInt32 old_size,
+                           void *ptr, SilcUInt32 size);
+
+
    +DESCRIPTION + +
    
+    Same as silc_srealloc but reallocates unaligned memory.
+
+
    +NOTES + +
    
+    This function can be used to reallocate only unaligned memory
+    allocated with silc_smalloc_ua.
+
+    If `stack' is NULL this function calls silc_realloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory-silc_sstrdup.html b/docs/toolkit/manual/silcmemory-silc_sstrdup.html new file mode 100644 index 0000000..c33eb82 --- /dev/null +++ b/docs/toolkit/manual/silcmemory-silc_sstrdup.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sstrdup

    + + +SYNOPSIS + +
    
+    char *silc_sstrdup(SilcStack stack, const char *str);
+
+
    +DESCRIPTION + +
    
+    Duplicates the string indicated by `str' and returns the duplicated
+    string.  This function allocates unaligned memory.  Returns NULL
+    on error.
+
+
    +NOTES + +
    
+    Be careful with this function:  do not free the returned pointer
+    explicitly and do not save the returned pointer to a permanent
+    location.
+
+    If `stack' is NULL this function calls silc_strdup.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Memory Interface
    +silc_malloc
    +silc_calloc
    +silc_realloc
    +silc_free
    +silc_memdup
    +silc_smalloc
    +silc_smalloc_ua
    +silc_scalloc
    +silc_srealloc
    +silc_srealloc_ua
    +silc_smemdup
    +silc_sstrdup
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory.html b/docs/toolkit/manual/silcmemory.html new file mode 100644 index 0000000..99cd969 --- /dev/null +++ b/docs/toolkit/manual/silcmemory.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmemory.html + + + + +
    + +SILC Memory Interface
    Header: silcmemory.h

    + + +DESCRIPTION + +
    
+ Basic utility functions for allocating memory. All SILC routines, and
+ applications use these functions when they need to allocate, manipulate
+ and free memory.
+
+
  • silc_malloc +
  • silc_calloc +
  • silc_realloc +
  • silc_free +
  • silc_memdup +
  • silc_smalloc +
  • silc_smalloc_ua +
  • silc_scalloc +
  • silc_srealloc +
  • silc_srealloc_ua +
  • silc_smemdup +
  • silc_sstrdup + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmemory.xref b/docs/toolkit/manual/silcmemory.xref new file mode 100644 index 0000000..b2c7a69 --- /dev/null +++ b/docs/toolkit/manual/silcmemory.xref @@ -0,0 +1,19 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmemory.h" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 0 + "SILC Memory Interface" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 1 + "silc_malloc" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_calloc" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_realloc" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_free" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_memdup" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_smalloc" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_smalloc_ua" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_scalloc" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_srealloc" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_srealloc_ua" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_smemdup" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + "silc_sstrdup" "/home/priikone/silc1/doc/toolkit/silcmemory.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmessage-SilcMessageFlags.html b/docs/toolkit/manual/silcmessage-SilcMessageFlags.html new file mode 100644 index 0000000..e8e76ad --- /dev/null +++ b/docs/toolkit/manual/silcmessage-SilcMessageFlags.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcMessageFlags

    + + +NAME + +
    
+    typedef SilcUInt16 SilcMessageFlags;
+
+
    +DESCRIPTION + +
    
+    The message flags type definition and the message flags.  The
+    message flags are used to indicate some status of the message.
+
+
    +SOURCE + +
        typedef SilcUInt16 SilcMessageFlags;
+    
+    /* The message flags */
+    #define SILC_MESSAGE_FLAG_NONE        0x0000      /* No flags */
+    #define SILC_MESSAGE_FLAG_AUTOREPLY   0x0001      /* Automatically replied */
+    #define SILC_MESSAGE_FLAG_NOREPLY     0x0002      /* Send no reply to this */
+    #define SILC_MESSAGE_FLAG_ACTION      0x0004      /* Action message */
+    #define SILC_MESSAGE_FLAG_NOTICE      0x0008      /* Notice message */
+    #define SILC_MESSAGE_FLAG_REQUEST     0x0010      /* A request */
+    #define SILC_MESSAGE_FLAG_SIGNED      0x0020      /* Message is signed */
+    #define SILC_MESSAGE_FLAG_REPLY       0x0040      /* A reply */
+    #define SILC_MESSAGE_FLAG_DATA        0x0080      /* MIME object */
+    #define SILC_MESSAGE_FLAG_UTF8        0x0100      /* UTF-8 string */
+    #define SILC_MESSAGE_FLAG_ACK         0x0200      /* ACK messages */
+    #define SILC_MESSAGE_FLAG_STOP        0x0400      /* Stop indication */
+    #define SILC_MESSAGE_FLAG_PACKET      0x0800      /* Contains SILC packet */
+    #define SILC_MESSAGE_FLAG_RESERVED    0x1000      /* to 0x1000 */
+    #define SILC_MESSAGE_FLAG_PRIVATE     0x2000      /* to 0x8000 */
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-SilcMessagePayload.html b/docs/toolkit/manual/silcmessage-SilcMessagePayload.html new file mode 100644 index 0000000..b31d58b --- /dev/null +++ b/docs/toolkit/manual/silcmessage-SilcMessagePayload.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcMessagePayload

    + + +NAME + +
    
+    typedef struct SilcMessagePayloadObject
+      *SilcMessagePayload, SilcMessagePayloadStruct;
+
+
+
    +DESCRIPTION + +
    
+    This context is the actual Message Payload and is allocated
+    by silc_message_payload_parse and given as argument usually
+    to all silc_message_* functions.  It is freed by the
+    silc_message_payload_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_get_data.html b/docs/toolkit/manual/silcmessage-silc_message_get_data.html new file mode 100644 index 0000000..927237f --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_get_data.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_get_data

    + + +SYNOPSIS + +
    
+    unsigned char *
+    silc_message_get_data(SilcMessagePayload payload,
+                                  SilcUInt32 *data_len);
+
+
    +DESCRIPTION + +
    
+    Return the data in the payload, that is, the actual message data.
+    The caller must not free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_get_flags.html b/docs/toolkit/manual/silcmessage-silc_message_get_flags.html new file mode 100644 index 0000000..1321e83 --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_get_flags.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_get_flags

    + + +SYNOPSIS + +
    
+    SilcMessageFlags silc_message_get_flags(SilcMessagePayload payload);
+
+
    +DESCRIPTION + +
    
+    Returns the message flags from the payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_get_mac.html b/docs/toolkit/manual/silcmessage-silc_message_get_mac.html new file mode 100644 index 0000000..671aef8 --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_get_mac.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_get_mac

    + + +SYNOPSIS + +
    
+    unsigned char *
+    silc_message_get_mac(SilcMessagePayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the MAC of the payload. The caller must already know the
+    length of the MAC. The caller must not free the MAC.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_payload_decrypt.html b/docs/toolkit/manual/silcmessage-silc_message_payload_decrypt.html new file mode 100644 index 0000000..a956a0e --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_payload_decrypt.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_payload_decrypt

    + + +SYNOPSIS + +
    
+    SilcBool silc_message_payload_decrypt(unsigned char *data,
+                                          size_t data_len,
+                                          SilcBool private_message,
+                                          SilcBool static_key,
+                                          SilcCipher cipher,
+                                          SilcHmac hmac,
+                                          unsigned char *sender_id,
+                                          SilcUInt32 sender_id_len,
+                                          unsigned char *receiver_id,
+                                          SilcUInt32 receiver_id_len,
+                                          SilcBool check_mac);
+
+
    +DESCRIPTION + +
    
+    Decrypt Message Payload indicated by `data'.  If the payload is
+    channel message then `private_message' is FALSE, and if it is
+    private message it is TRUE.  If the private message key is static
+    (pre-shared key) then protocol dictates that the IV is present
+    and `static_key' must be set to TRUE.  If the key is not static
+    (Key Agreement was done for the key) then it MUST be FALSE.  For
+    channel messages the `static_key' is ignored.
+
+    The `sender_id' and `receiver_id' are the IDs from the packet header
+    of the packet where this message payload was received.
+
+    This is usually used by the Message Payload interface itself but can
+    be called by the appliation if separate decryption process is required.
+    For example server might need to call this directly in some
+    circumstances. The `cipher' is used to decrypt the payload.  If
+    `check_mac' is FALSE then MAC is not verified.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_payload_encode.html b/docs/toolkit/manual/silcmessage-silc_message_payload_encode.html new file mode 100644 index 0000000..5240bc9 --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_payload_encode.html @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_message_payload_encode(SilcMessageFlags flags,
+                                           const unsigned char *data,
+                                           SilcUInt32 data_len,
+                                           SilcBool generate_iv,
+                                           SilcBool private_message,
+                                           SilcCipher cipher,
+                                           SilcHmac hmac,
+                                           SilcRng rng,
+                                           SilcPublicKey public_key,
+                                           SilcPrivateKey private_key,
+                                           SilcHash hash,
+                                           SilcID *sender_id,
+                                           SilcID *receiver_id,
+                                           SilcBuffer buffer);
+
+
    +DESCRIPTION + +
    
+    Encodes a Message Payload into a buffer and returns it.  This is
+    used to encode channel messages and private messages into a packet.
+    If `private_message' is FALSE then this encodes channel message, if
+    it is TRUE this encodes private message.  If `private_message' is
+    TRUE then `generate_iv' MUST be FALSE if the private message key
+    `cipher' is not static key (pre-shared key).  If it is static key
+    then protocol dictates that IV must be present in the Message Payload
+    and `generate_iv' must be TRUE.  The caller must know whether the key
+    is static or not for private messages.  If the key was generated with
+    Key Agreement protocol then `generate_iv' is always FALSE.  For
+    channel messages `generate_iv' is always set to TRUE value.
+
+    The `cipher' is the cipher used to encrypt the message and `hmac'
+    is used to compute the MAC for the payload.  If encoding private
+    message that will be encrypted with session keys (no private message
+    key) then `cipher' and `hmac' is NULL and this merely encodes the
+    payload buffer, and the caller must encrypt the packet later.
+    If `rng' is NULL then global RNG is used, if non-NULL then the
+    `rng' is used (for IV and padding generation).
+
+    The `public_key', `private_key' and `hash' are provided only if the
+    flags includes SILC_MESSAGE_FLAG_SIGNED, in which case the message
+    will be digitally signed.  If `public_key' is non-NULL then it will
+    be included in the message.  The `private_message' and `hash' MUST
+    be provided.  The `hash' SHOULD be SHA1.
+
+    The `sender_id' is the ID message sender and `receiver_id' is ID of
+    message receiver.
+
+    If the `buffer' is non-NULL then the payload will be encoded into
+    that buffer.  The same buffer is returned.  Otherwise new buffer is
+    allocated and returned.  The `buffer' will be automatically enlarged
+    if the payload does not fit to it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_payload_encrypt.html b/docs/toolkit/manual/silcmessage-silc_message_payload_encrypt.html new file mode 100644 index 0000000..60ed75d --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_payload_encrypt.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_payload_encrypt

    + + +SYNOPSIS + +
    
+    SilcBool silc_message_payload_encrypt(unsigned char *data,
+                                          SilcUInt32 data_len,
+                                          SilcUInt32 true_len,
+                                          unsigned char *iv,
+                                          SilcID *sender_id,
+                                          SilcID *receiver_id,
+                                          SilcCipher cipher,
+                                          SilcHmac hmac);
+
+
    +DESCRIPTION + +
    
+    This function is used to encrypt the Messsage Payload which is
+    the `data' and `data_len'.  The `data_len' is the data length which
+    is used to create MAC out of.  The `data' MUST have additional space
+    after `true_len' bytes for the MAC which is appended to the data.
+    The `sender_id' is the ID message sender and `receiver_id' is ID of
+    message receiver.
+
+    This is usually used by the Message Payload interface itself but can
+    be called by the appliation if separate encryption process is required.
+    For example server might need to call this directly in some
+    circumstances. The `cipher' is used to encrypt the payload and `hmac'
+    to compute the MAC for the payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_payload_free.html b/docs/toolkit/manual/silcmessage-silc_message_payload_free.html new file mode 100644 index 0000000..831315a --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_payload_free.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_payload_free

    + + +SYNOPSIS + +
    
+    void silc_message_payload_free(SilcMessagePayload payload);
+
+
    +DESCRIPTION + +
    
+    Free's Message Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_payload_parse.html b/docs/toolkit/manual/silcmessage-silc_message_payload_parse.html new file mode 100644 index 0000000..4e870a9 --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_payload_parse.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_payload_parse

    + + +SYNOPSIS + +
    
+    SilcMessagePayload
+    silc_message_payload_parse(unsigned char *payload,
+                               SilcUInt32 payload_len,
+                               SilcBool private_message,
+                               SilcBool static_key,
+                               SilcCipher cipher,
+                               SilcHmac hmac,
+                               unsigned char *sender_id,
+                               SilcUInt32 sender_id_len,
+                               unsigned char *receiver_id,
+                               SilcUInt32 receiver_id_len,
+                               SilcStack stack,
+                               SilcBool no_allocation,
+                               SilcMessagePayload message);
+
+
    +DESCRIPTION + +
    
+    Parses Message Payload returning new payload structure.  This also
+    decrypts the payload and checks the MAC.  If the payload is
+    channel message then `private_message' is FALSE, and if it is
+    private message it is TRUE.  If the private message key is static
+    (pre-shared key) then protocol dictates that the IV is present
+    and `static_key' must be set to TRUE.  If the key is not static
+    (Key Agreement was done for the key) then it MUST be FALSE.  For
+    channel messages the `static_key' is ignored.
+
+    If the `hmac' is no provided then the MAC of the channel message is
+    not verified.  If the message is private message and `cipher' is NULL
+    then this assumes that the packet was decrypted with session keys
+    (no private message key) and this merely decodes the payload.
+
+    The `sender_id' and `receiver_id' are the IDs from the packet header
+    of the packet where this message payload was received.
+
+    If the `message' is non-NULL then that pre-allocated context is
+    used in parsing.  Same context is returned.  Otherwise new context
+    is allocated and returned.  If the `stack' is non-NULL then memory
+    is allocated from that stack.  If `no_allocation' is TRUE then the
+    `message' must be provided and data is merely parsed and referenced
+    from `payload' and will become invalid when `payload' invalidates.
+    If `no_allocation' is TRUE the routine does not do any allocations.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_signed_get_public_key.html b/docs/toolkit/manual/silcmessage-silc_message_signed_get_public_key.html new file mode 100644 index 0000000..6ff9dd9 --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_signed_get_public_key.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_signed_get_public_key

    + + +SYNOPSIS + +
    
+    SilcPublicKey
+    silc_message_signed_get_public_key(SilcMessagePayload payload,
+                                       const unsigned char **pk_data,
+                                       SilcUInt32 *pk_data_len);
+
+
    +DESCRIPTION + +
    
+    Returns the decoded SilcPublicKey from the message payload or NULL
+    if it does not include public key.  The caller must free the returned
+    public key pointer.  This also returns the raw public key (before
+    decoding) into `pk_data' and `pk_data_len' if they are provided.  The
+    caller must not free these pointers.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage-silc_message_signed_verify.html b/docs/toolkit/manual/silcmessage-silc_message_signed_verify.html new file mode 100644 index 0000000..bdf1935 --- /dev/null +++ b/docs/toolkit/manual/silcmessage-silc_message_signed_verify.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_message_signed_verify

    + + +SYNOPSIS + +
    
+    SilcAuthResult
+    silc_message_signed_verify(SilcMessagePayload message,
+                               SilcPublicKey remote_public_key,
+                               SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    This routine can be used to verify the digital signature from the
+    message indicated by `message'.  The signature is present only if
+    the SILC_MESSAGE_FLAG_SIGNED is set in the message flags.  This
+    returns SILC_AUTH_OK if the signature verification was successful.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Message Interface
    +SilcMessagePayload
    +SilcMessageFlags
    +silc_message_payload_decrypt
    +silc_message_payload_parse
    +silc_message_payload_encrypt
    +silc_message_payload_encode
    +silc_message_payload_free
    +silc_message_get_flags
    +silc_message_get_data
    +silc_message_get_mac
    +silc_message_signed_verify
    +silc_message_signed_get_public_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage.html b/docs/toolkit/manual/silcmessage.html new file mode 100644 index 0000000..1cf7ab4 --- /dev/null +++ b/docs/toolkit/manual/silcmessage.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmessage.html + + + + +
    + +SILC Message Interface
    Header: silcmessage.h

    + + +DESCRIPTION + +
    
+ This interface includes the implementation of the Message Payload that
+ is used to send private messages and channel messages.  The interface
+ is also able to automatically provide digital signature in the messages
+ if it is requested.  Message digital signatures may also be verified with
+ this interface.
+
+
  • SilcMessagePayload +
  • SilcMessageFlags +
  • silc_message_payload_decrypt +
  • silc_message_payload_parse +
  • silc_message_payload_encrypt +
  • silc_message_payload_encode +
  • silc_message_payload_free +
  • silc_message_get_flags +
  • silc_message_get_data +
  • silc_message_get_mac +
  • silc_message_signed_verify +
  • silc_message_signed_get_public_key + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage.xref b/docs/toolkit/manual/silcmessage.xref new file mode 100644 index 0000000..68dc33f --- /dev/null +++ b/docs/toolkit/manual/silcmessage.xref @@ -0,0 +1,19 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmessage.h" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 0 + "SILC Message Interface" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 1 + "SilcMessagePayload" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 5 + "SilcMessageFlags" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 8 + "silc_message_payload_decrypt" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_payload_parse" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_payload_encrypt" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_payload_encode" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_payload_free" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_get_flags" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_get_data" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_get_mac" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_signed_verify" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + "silc_message_signed_get_public_key" "/home/priikone/silc1/doc/toolkit/silcmessage.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmessage_i.html b/docs/toolkit/manual/silcmessage_i.html new file mode 100644 index 0000000..937ef29 --- /dev/null +++ b/docs/toolkit/manual/silcmessage_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmessage_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmessage_i.xref b/docs/toolkit/manual/silcmessage_i.xref new file mode 100644 index 0000000..3b32bca --- /dev/null +++ b/docs/toolkit/manual/silcmessage_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmessage_i.h" "/home/priikone/silc1/doc/toolkit/silcmessage_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmime-SilcMime.html b/docs/toolkit/manual/silcmime-SilcMime.html new file mode 100644 index 0000000..12d888c --- /dev/null +++ b/docs/toolkit/manual/silcmime-SilcMime.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcMime

    + + +NAME + +
    
+    typedef struct SilcMimeStruct *SilcMime;
+
+
    +DESCRIPTION + +
    
+    This context is the actual MIME message and is allocated
+    by silc_mime_alloc and given as argument to all silc_mime_*
+    functions.  It is freed by the silc_mime_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-SilcMimeAssembler.html b/docs/toolkit/manual/silcmime-SilcMimeAssembler.html new file mode 100644 index 0000000..3b4edde --- /dev/null +++ b/docs/toolkit/manual/silcmime-SilcMimeAssembler.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcMimeAssembler

    + + +NAME + +
    
+    typedef struct SilcMimeAssemblerStruct *SilcMimeAssembler;
+
+
    +DESCRIPTION + +
    
+    This context is a SILC MIME Assembler that is used to assemble partial
+    MIME messages (fgraments) into complete MIME messages.  It is allocated
+    by silc_mime_assembler_alloc and freed by silc_mime_assembler_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_add_data.html b/docs/toolkit/manual/silcmime-silc_mime_add_data.html new file mode 100644 index 0000000..57d1cb7 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_add_data.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_add_data

    + + +SYNOPSIS + +
    
+    void silc_mime_add_data(SilcMime mime, const unsigned char *data,
+                            SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Adds the actual MIME data to the `mime' message.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_add_field.html b/docs/toolkit/manual/silcmime-silc_mime_add_field.html new file mode 100644 index 0000000..d126b4a --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_add_field.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_add_field

    + + +SYNOPSIS + +
    
+    void silc_mime_add_field(SilcMime mime,
+                             const char *field, const char *value);
+
+
    +DESCRIPTION + +
    
+    Adds a field indicated by `field' to MIME message `mime'.  The field
+    value is `value'.
+
+
    +EXAMPLE + +
    
+    silc_mime_add_field(mime, "MIME-Version", "1.0");
+    silc_mime_add_field(mime, "Content-Type", "image/jpeg");
+    silc_mime_add_field(mime, "Content-Transfer-Encoding", "binary");
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_add_multipart.html b/docs/toolkit/manual/silcmime-silc_mime_add_multipart.html new file mode 100644 index 0000000..a4ad9d5 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_add_multipart.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_add_multipart

    + + +SYNOPSIS + +
    
+    SilcBool silc_mime_add_multipart(SilcMime mime, SilcMime part);
+
+
    +DESCRIPTION + +
    
+    Adds a multipart `part` to MIME message `mime'.  The `part' will be
+    freed automatically when silc_mime_free is called for `mime'.  Returns
+    TRUE if `part' was added to `mime' and FALSE if `mime' is not marked
+    as multipart MIME message.
+
+
    +NOTES + +
    
+    The silc_mime_set_multipart must be called for `mime' before parts
+    can be added to it.  Otherwise FALSE will be returned.
+
+
    +EXAMPLE + +
    
+    part = silc_mime_alloc();
+    silc_mime_add_field(part, "Content-Type", "image/jpeg");
+    silc_mime_add_data(part, data, data_len);
+
+    silc_mime_set_multipart(mime, "mixed", "boundary1");
+    silc_mime_add_multipart(mime, part);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_alloc.html b/docs/toolkit/manual/silcmime-silc_mime_alloc.html new file mode 100644 index 0000000..dc5ae7f --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_alloc.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_alloc

    + + +SYNOPSIS + +
    
+    SilcMime silc_mime_alloc(void)
+
+
    +DESCRIPTION + +
    
+    Allocates SILC Mime message context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_assemble.html b/docs/toolkit/manual/silcmime-silc_mime_assemble.html new file mode 100644 index 0000000..a5a0e6c --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_assemble.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_assemble

    + + +SYNOPSIS + +
    
+    SilcMime silc_mime_assemble(SilcMimeAssembler assembler,
+                                SilcMime partial);
+
+
    +DESCRIPTION + +
    
+    Processes and attempts to assemble the received MIME fragment `partial'.
+    To check if a received MIME message is a fragment use the
+    silc_mime_is_partial function.  Returns NULL if all fragments has not
+    yet been received, or the newly allocated completed MIME message if
+    all fragments were received.  The caller must free the returned
+    SilcMime context.  The caller must not free the `partial'.
+
+
    +EXAMPLE + +
    
+    // Assemble received MIME fragment
+    mime = silc_mime_decode(data, data_len);
+    if (silc_mime_is_partial(mime) == TRUE) {
+      complete = silc_mime_assmeble(assembler, mime);
+      if (complete == NULL)
+        return;
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_assembler_alloc.html b/docs/toolkit/manual/silcmime-silc_mime_assembler_alloc.html new file mode 100644 index 0000000..0cbcd3a --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_assembler_alloc.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_assembler_alloc

    + + +SYNOPSIS + +
    
+    SilcMimeAssembler silc_mime_assembler_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates MIME fragment assembler.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_assembler_free.html b/docs/toolkit/manual/silcmime-silc_mime_assembler_free.html new file mode 100644 index 0000000..f097cbd --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_assembler_free.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_assembler_free

    + + +SYNOPSIS + +
    
+    void silc_mime_assembler_free(SilcMimeAssembler assembler)
+
+
    +DESCRIPTION + +
    
+    Frees `assembler' context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_decode.html b/docs/toolkit/manual/silcmime-silc_mime_decode.html new file mode 100644 index 0000000..1293cc1 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_decode.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_decode

    + + +SYNOPSIS + +
    
+    SilcMime silc_mime_decode(SilcMime mime, const unsigned char *data,
+                              SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Decodes a MIME message and returns the parsed message into newly
+    allocated SilcMime context and returns it.  If `mime' is non-NULL
+    then the MIME message will be encoded into the pre-allocated `mime'
+    context and same context is returned.  If it is NULL then newly
+    allocated SilcMime context is returned.  On error NULL is returned.
+
+
    +EXAMPLE + +
    
+    // Parse MIME message and get its content type
+    mime = silc_mime_decode(NULL, data, data_len);
+    type = silc_mime_get_field(mime, "Content-Type");
+    ...
+
+    // Assemble received MIME fragment
+    mime = silc_mime_decode(NULL, data, data_len);
+    if (silc_mime_is_partial(mime) == TRUE)
+      silc_mime_assmeble(assembler, mime);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_encode.html b/docs/toolkit/manual/silcmime-silc_mime_encode.html new file mode 100644 index 0000000..29e2f6a --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_encode.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_encode

    + + +SYNOPSIS + +
    
+    unsigned char *silc_mime_encode(SilcMime mime, SilcUInt32 *encoded_len);
+
+
    +DESCRIPTION + +
    
+    Encodes the `mime' context into a raw MIME message (may be human
+    readable).  The caller must free the returned buffer.  If the `mime'
+    is multipart MIME message all parts will be automatically encoded
+    as well.
+
+    If you want to create fragmented MIME message use the function
+    silc_mime_encode_partial.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_encode_partial.html b/docs/toolkit/manual/silcmime-silc_mime_encode_partial.html new file mode 100644 index 0000000..3d96de2 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_encode_partial.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_encode_partial

    + + +SYNOPSIS + +
    
+    SilcDList silc_mime_encode_partial(SilcMime mime, int max_size);
+
+
    +DESCRIPTION + +
    
+    Same as silc_mime_encode except fragments the MIME message `mime'
+    if it is larger than `max_size' in bytes.  Returns the MIME fragments
+    in SilcDList where each entry is SilcBuffer context.  The caller must
+    free the returned list and all SilcBuffer entries in it by calling
+    silc_mime_partial_free function.
+
+    To assemble the fragments into a complete MIME message the
+    silc_mime_assemble can be used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_free.html b/docs/toolkit/manual/silcmime-silc_mime_free.html new file mode 100644 index 0000000..000ea04 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_free.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_free

    + + +SYNOPSIS + +
    
+    void silc_mime_alloc(SilcMime mime)
+
+
    +DESCRIPTION + +
    
+    Frees `mime' context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_get_data.html b/docs/toolkit/manual/silcmime-silc_mime_get_data.html new file mode 100644 index 0000000..4de6a59 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_get_data.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_get_data

    + + +SYNOPSIS + +
    
+    const unsigned char *
+    silc_mime_get_data(SilcMime mime, SilcUInt32 *data_len);
+
+
    +DESCRIPTION + +
    
+    Returns the MIME data from the `mime' message.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_get_field.html b/docs/toolkit/manual/silcmime-silc_mime_get_field.html new file mode 100644 index 0000000..56c07ec --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_get_field.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_get_field

    + + +SYNOPSIS + +
    
+    const char *silc_mime_get_field(SilcMime mime, const char *field);
+
+
    +DESCRIPTION + +
    
+    Returns the `field' value or NULL if such field does not exist in the
+    MIME message `mime'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_get_multiparts.html b/docs/toolkit/manual/silcmime-silc_mime_get_multiparts.html new file mode 100644 index 0000000..9918101 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_get_multiparts.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_get_multiparts

    + + +SYNOPSIS + +
    
+    SilcDList silc_mime_get_multiparts(SilcMime mime, const char **type);
+
+
    +DESCRIPTION + +
    
+    Returns list of the parts from the MIME message `mime'.  Each entry
+    in the list is SilcMime context.  The caller must not free the returned
+    list or the SilcMime contexts in the list.  Returns NULL if no parts
+    exists in the MIME message.  Returns the multipart type (like "mixed")
+    into `type' pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_is_multipart.html b/docs/toolkit/manual/silcmime-silc_mime_is_multipart.html new file mode 100644 index 0000000..7088729 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_is_multipart.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_is_multipart

    + + +SYNOPSIS + +
    
+    SilcBool silc_mime_is_multipart(SilcMime mime);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the MIME message `mime' is a multipart MIME message.
+    Its parts can be get by calling silc_mime_get_multiparts.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_is_partial.html b/docs/toolkit/manual/silcmime-silc_mime_is_partial.html new file mode 100644 index 0000000..650084f --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_is_partial.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_is_partial

    + + +SYNOPSIS + +
    
+    SilcBool silc_mime_is_partial(SilcMime mime);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the MIME message `mime' is a partial MIME fragment.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_partial_free.html b/docs/toolkit/manual/silcmime-silc_mime_partial_free.html new file mode 100644 index 0000000..fdfe73b --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_partial_free.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_partial_free

    + + +SYNOPSIS + +
    
+    void silc_mime_partial_free(SilcDList partials);
+
+
    +DESCRIPTION + +
    
+    This function must be called to free the list returned by the
+    silc_mime_encode_partial function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_set_multipart.html b/docs/toolkit/manual/silcmime-silc_mime_set_multipart.html new file mode 100644 index 0000000..7ec52b6 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_set_multipart.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_set_multipart

    + + +SYNOPSIS + +
    
+    void silc_mime_set_multipart(SilcMime mime, const char *type,
+                                 const char *boundary);
+
+
    +DESCRIPTION + +
    
+    Sets the `mime' to be a multipart MIME message.  The `type' specifies
+    the multipart type, usually "mixed", but can be something else too.
+    The `boundary' specifies the multipart boundary.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime-silc_mime_steal_data.html b/docs/toolkit/manual/silcmime-silc_mime_steal_data.html new file mode 100644 index 0000000..b232175 --- /dev/null +++ b/docs/toolkit/manual/silcmime-silc_mime_steal_data.html @@ -0,0 +1,235 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mime_steal_data

    + + +SYNOPSIS + +
    
+    unsigned char *
+    silc_mime_steal_data(SilcMime mime, SilcUInt32 *data_len);
+
+
    +DESCRIPTION + +
    
+    Returns the MIME data from the `mime' message.  The data will be
+    removed from the `mime' and the caller is responsible of freeing the
+    returned pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MIME Interface
    +SilcMime
    +SilcMimeAssembler
    +silc_mime_alloc
    +silc_mime_free
    +silc_mime_assembler_alloc
    +silc_mime_assembler_free
    +silc_mime_decode
    +silc_mime_encode
    +silc_mime_assemble
    +silc_mime_encode_partial
    +silc_mime_partial_free
    +silc_mime_add_field
    +silc_mime_get_field
    +silc_mime_add_data
    +silc_mime_get_data
    +silc_mime_steal_data
    +silc_mime_is_partial
    +silc_mime_set_multipart
    +silc_mime_add_multipart
    +silc_mime_is_multipart
    +silc_mime_get_multiparts
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime.html b/docs/toolkit/manual/silcmime.html new file mode 100644 index 0000000..eb5344c --- /dev/null +++ b/docs/toolkit/manual/silcmime.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmime.html + + + + +
    + +SILC MIME Interface
    Header: silcmime.h

    + + +DESCRIPTION + +
    
+ Simple implementation of MIME.  Supports creation and parsing of simple
+ MIME messages, multipart MIME messages, including nested multiparts, and
+ MIME fragmentation and defragmentation.
+
+ SILC Mime API is not thread-safe.  If the same MIME context must be
+ used in multithreaded environment concurrency control must be employed.
+
+
  • SilcMime +
  • SilcMimeAssembler +
  • silc_mime_alloc +
  • silc_mime_free +
  • silc_mime_assembler_alloc +
  • silc_mime_assembler_free +
  • silc_mime_decode +
  • silc_mime_encode +
  • silc_mime_assemble +
  • silc_mime_encode_partial +
  • silc_mime_partial_free +
  • silc_mime_add_field +
  • silc_mime_get_field +
  • silc_mime_add_data +
  • silc_mime_get_data +
  • silc_mime_steal_data +
  • silc_mime_is_partial +
  • silc_mime_set_multipart +
  • silc_mime_add_multipart +
  • silc_mime_is_multipart +
  • silc_mime_get_multiparts + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime.xref b/docs/toolkit/manual/silcmime.xref new file mode 100644 index 0000000..b987d3a --- /dev/null +++ b/docs/toolkit/manual/silcmime.xref @@ -0,0 +1,28 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmime.h" "/home/priikone/silc1/doc/toolkit/silcmime.html" 0 + "SILC MIME Interface" "/home/priikone/silc1/doc/toolkit/silcmime.html" 1 + "SilcMime" "/home/priikone/silc1/doc/toolkit/silcmime.html" 5 + "SilcMimeAssembler" "/home/priikone/silc1/doc/toolkit/silcmime.html" 5 + "silc_mime_alloc" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_free" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_assembler_alloc" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_assembler_free" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_decode" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_encode" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_assemble" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_encode_partial" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_partial_free" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_add_field" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_get_field" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_add_data" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_get_data" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_steal_data" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_is_partial" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_set_multipart" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_add_multipart" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_is_multipart" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + "silc_mime_get_multiparts" "/home/priikone/silc1/doc/toolkit/silcmime.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmime_i.html b/docs/toolkit/manual/silcmime_i.html new file mode 100644 index 0000000..114471c --- /dev/null +++ b/docs/toolkit/manual/silcmime_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmime_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmime_i.xref b/docs/toolkit/manual/silcmime_i.xref new file mode 100644 index 0000000..29a22a8 --- /dev/null +++ b/docs/toolkit/manual/silcmime_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmime_i.h" "/home/priikone/silc1/doc/toolkit/silcmime_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmode-ChannelModes.html b/docs/toolkit/manual/silcmode-ChannelModes.html new file mode 100644 index 0000000..7de99f7 --- /dev/null +++ b/docs/toolkit/manual/silcmode-ChannelModes.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +ChannelModes

    + + +DESCRIPTION + +
    
+    All channel modes.
+
+
    +SOURCE + +
        #define SILC_CHANNEL_MODE_NONE          0x0000
+    #define SILC_CHANNEL_MODE_PRIVATE       0x0001 /* private channel */
+    #define SILC_CHANNEL_MODE_SECRET        0x0002 /* secret channel */
+    #define SILC_CHANNEL_MODE_PRIVKEY       0x0004 /* channel has private key */
+    #define SILC_CHANNEL_MODE_INVITE        0x0008 /* invite only channel */
+    #define SILC_CHANNEL_MODE_TOPIC         0x0010 /* topic setting by operator */
+    #define SILC_CHANNEL_MODE_ULIMIT        0x0020 /* user limit set */
+    #define SILC_CHANNEL_MODE_PASSPHRASE    0x0040 /* passphrase set */
+    #define SILC_CHANNEL_MODE_CIPHER        0x0080 /* sets cipher of the channel */
+    #define SILC_CHANNEL_MODE_HMAC          0x0100 /* sets hmac of the channel */
+    #define SILC_CHANNEL_MODE_FOUNDER_AUTH  0x0200 /* sets founder auth data */
+    #define SILC_CHANNEL_MODE_SILENCE_USERS 0x0400 /* sets founder auth data */
+    #define SILC_CHANNEL_MODE_SILENCE_OPERS 0x0800 /* sets founder auth data */
+    #define SILC_CHANNEL_MODE_CHANNEL_AUTH  0x1000 /* channel auth (signature) */
    +



    +
    +     		+ + + + +
    +
    + +SILC Modes
    +ChannelModes
    +ChannelUserModes
    +SilcUserMode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmode-ChannelUserModes.html b/docs/toolkit/manual/silcmode-ChannelUserModes.html new file mode 100644 index 0000000..2b78f37 --- /dev/null +++ b/docs/toolkit/manual/silcmode-ChannelUserModes.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +ChannelUserModes

    + + +DESCRIPTION + +
    
+    All user modes on channel.  These indicate the user's status on the
+    channel.  Some of the modes can be set by channel founder and channel
+    operator.  Some modes may be set by users themself.
+
+
    +SOURCE + +
        #define SILC_CHANNEL_UMODE_NONE            0x00000000 /* Normal user */
+    #define SILC_CHANNEL_UMODE_CHANFO          0x00000001 /* channel founder */
+    #define SILC_CHANNEL_UMODE_CHANOP          0x00000002 /* channel operator */
+    #define SILC_CHANNEL_UMODE_BLOCK_MESSAGES  0x00000004 /* messages blocked */
+    #define SILC_CHANNEL_UMODE_BLOCK_MESSAGES_USERS  0x00000008 /* Block messages
+                                                                   from normal
+                                                                   users */
+    #define SILC_CHANNEL_UMODE_BLOCK_MESSAGES_ROBOTS 0x00000010 /* Block messages
+                                                                   from robots */
+    #define SILC_CHANNEL_UMODE_QUIET           0x00000020 /* user is quiet */
    +



    +
    +     		+ + + + +
    +
    + +SILC Modes
    +ChannelModes
    +ChannelUserModes
    +SilcUserMode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmode-SilcUserMode.html b/docs/toolkit/manual/silcmode-SilcUserMode.html new file mode 100644 index 0000000..1771d38 --- /dev/null +++ b/docs/toolkit/manual/silcmode-SilcUserMode.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcUserMode

    + + +DESCRIPTION + +
    
+    SILC User modes. These indicate the status and presence of the client
+    in the SILC network.
+
+
    +SOURCE + +
        #define SILC_UMODE_NONE              0x00000000 /* Normal SILC user */
+    #define SILC_UMODE_SERVER_OPERATOR   0x00000001 /* Server operator */
+    #define SILC_UMODE_ROUTER_OPERATOR   0x00000002 /* Router (SILC) operator */
+    #define SILC_UMODE_GONE              0x00000004 /* Client is gone */
+    #define SILC_UMODE_INDISPOSED        0x00000008 /* Client is indisposed */
+    #define SILC_UMODE_BUSY              0x00000010 /* Client is busy */
+    #define SILC_UMODE_PAGE              0x00000020 /* Client requests paging */
+    #define SILC_UMODE_HYPER             0x00000040 /* Client is hyper active */
+    #define SILC_UMODE_ROBOT             0x00000080 /* Client is a robot */
+    #define SILC_UMODE_ANONYMOUS         0x00000100 /* Client is anonymous */
+    #define SILC_UMODE_BLOCK_PRIVMSG     0x00000200 /* Client blocks privmsgs */
+    #define SILC_UMODE_DETACHED          0x00000400 /* Client is detached */
+    #define SILC_UMODE_REJECT_WATCHING   0x00000800 /* Client rejects watching */
+    #define SILC_UMODE_BLOCK_INVITE      0x00001000 /* Client blocks invites */
    +



    +
    +     		+ + + + +
    +
    + +SILC Modes
    +ChannelModes
    +ChannelUserModes
    +SilcUserMode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmode.html b/docs/toolkit/manual/silcmode.html new file mode 100644 index 0000000..f1c50a5 --- /dev/null +++ b/docs/toolkit/manual/silcmode.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmode.html + + + + +
    + +SILC Modes
    Header: silcmode.h

    + + +DESCRIPTION + +
    
+ This header includes all mode definitions for the SILC. It includes
+ channel modes, channel user mode and user modes.
+
+
  • ChannelModes +
  • ChannelUserModes +
  • SilcUserMode + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmode.xref b/docs/toolkit/manual/silcmode.xref new file mode 100644 index 0000000..659354f --- /dev/null +++ b/docs/toolkit/manual/silcmode.xref @@ -0,0 +1,10 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmode.h" "/home/priikone/silc1/doc/toolkit/silcmode.html" 0 + "SILC Modes" "/home/priikone/silc1/doc/toolkit/silcmode.html" 1 + "ChannelModes" "/home/priikone/silc1/doc/toolkit/silcmode.html" 8 + "ChannelUserModes" "/home/priikone/silc1/doc/toolkit/silcmode.html" 8 + "SilcUserMode" "/home/priikone/silc1/doc/toolkit/silcmode.html" 8 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmp-SilcMPInt.html b/docs/toolkit/manual/silcmp-SilcMPInt.html new file mode 100644 index 0000000..f771164 --- /dev/null +++ b/docs/toolkit/manual/silcmp-SilcMPInt.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcMPInt

    + + +NAME + +
    
+    typedef SILC_MP_INT SilcMPInt;
+
+
    +DESCRIPTION + +
    
+    The SILC MP Integer definition. This is the actual MP integer.
+    The type is defined as SILC_MP_INT as it is implementation specific
+    and is unknown to the application.
+
+
    +SOURCE + +
        typedef SILC_MP_INT SilcMPInt;
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_abs.html b/docs/toolkit/manual/silcmp-silc_mp_abs.html new file mode 100644 index 0000000..8b7990e --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_abs.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_abs

    + + +SYNOPSIS + +
    
+    void silc_mp_abs(SilcMPInt *src, SilcMPInt *dst);
+
+
    +DESCRIPTION + +
    
+    Assign the absolute value of `src' to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_add.html b/docs/toolkit/manual/silcmp-silc_mp_add.html new file mode 100644 index 0000000..070d889 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_add.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_add

    + + +SYNOPSIS + +
    
+    void silc_mp_add(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Add two integers `mp1' and `mp2' and save the result to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_add_ui.html b/docs/toolkit/manual/silcmp-silc_mp_add_ui.html new file mode 100644 index 0000000..887fa32 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_add_ui.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_add_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_add_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui);
+
+
    +DESCRIPTION + +
    
+    Add two integers `mp1' and unsigned word `ui' and save the result
+    to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_and.html b/docs/toolkit/manual/silcmp-silc_mp_and.html new file mode 100644 index 0000000..60c8706 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_and.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_and

    + + +SYNOPSIS + +
    
+    void silc_mp_and(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Logical and operator. The result is saved to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_bin2mp.html b/docs/toolkit/manual/silcmp-silc_mp_bin2mp.html new file mode 100644 index 0000000..cd49882 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_bin2mp.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_bin2mp

    + + +SYNOPSIS + +
    
+    void silc_mp_bin2mp(unsigned char *data, SilcUInt32 len,
+                        SilcMPInt *ret);
+
+
    +DESCRIPTION + +
    
+    Decodes binary data into MP integer. The integer sent as argument
+    must be initialized.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_cmp.html b/docs/toolkit/manual/silcmp-silc_mp_cmp.html new file mode 100644 index 0000000..5a2548b --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_cmp.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_cmp

    + + +SYNOPSIS + +
    
+    int silc_mp_cmp(SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Compare `mp1' and `mp2'. Returns posivite, zero, or negative
+    if `mp1' > `mp2', `mp1' == `mp2', or `mp1' < `mp2', respectively.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_cmp_si.html b/docs/toolkit/manual/silcmp-silc_mp_cmp_si.html new file mode 100644 index 0000000..cf90af0 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_cmp_si.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_cmp_si

    + + +SYNOPSIS + +
    
+    int silc_mp_cmp_si(SilcMPInt *mp1, SilcInt32 si);
+
+
    +DESCRIPTION + +
    
+    Compare `mp1' and single word `si'. Returns posivite, zero, or negative
+    if `mp1' > `si', `mp1' == `si', or `mp1' < `si', respectively.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_cmp_ui.html b/docs/toolkit/manual/silcmp-silc_mp_cmp_ui.html new file mode 100644 index 0000000..a5d7280 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_cmp_ui.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_cmp_ui

    + + +SYNOPSIS + +
    
+    int silc_mp_cmp_ui(SilcMPInt *mp1, SilcUInt32 ui);
+
+
    +DESCRIPTION + +
    
+    Compare `mp1' and unsigned word `ui'. Returns posivite, zero, or
+    negative if `mp1' > `ui', `mp1' == `ui', or `mp1' < `ui',
+    respectively.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_div.html b/docs/toolkit/manual/silcmp-silc_mp_div.html new file mode 100644 index 0000000..d68031b --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_div.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_div

    + + +SYNOPSIS + +
    
+    void silc_mp_div(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Divide the `mp1' and `mp2' and save the result to the `dst'. This
+    is equivalent to dst = mp1 / mp2;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_div_2exp.html b/docs/toolkit/manual/silcmp-silc_mp_div_2exp.html new file mode 100644 index 0000000..55f296b --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_div_2exp.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_div_2exp

    + + +SYNOPSIS + +
    
+    void silc_mp_div_2exp(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Divide the `mp1' with 2 ** `exp' and save the result to `dst'.
+    This is equivalent to dst = mp1 / (2 ^ exp).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_div_2exp_qr.html b/docs/toolkit/manual/silcmp-silc_mp_div_2exp_qr.html new file mode 100644 index 0000000..a8bac06 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_div_2exp_qr.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_div_2exp_qr

    + + +SYNOPSIS + +
    
+    void silc_mp_div_2exp_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1,
+                             SilcUInt32 exp);
+
+
    +DESCRIPTION + +
    
+    Divide the `mp1' with 2 ** `exp' and save the quotient to `q' and
+    the remainder to `r'. This is equivalent to q = mp1 / (2 ^ exp),
+    r = mp1 mod (2 ^ exp). If the `q' or `r' is NULL then the operation
+    is omitted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_div_qr.html b/docs/toolkit/manual/silcmp-silc_mp_div_qr.html new file mode 100644 index 0000000..70d2831 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_div_qr.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_div_qr

    + + +SYNOPSIS + +
    
+    void silc_mp_div_qr(SilcMPInt *q, SilcMPInt *r, SilcMPInt *mp1,
+                        SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Divide the `mp1' and `mp2' and save the quotient to the `q' and
+    the remainder to the `r'.  This is equivalent to the q = mp1 / mp2,
+    r = mp1 mod mp2 (or mp1 = mp2 * q + r). If the `q' or `r' is NULL
+    then the operation is omitted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_div_ui.html b/docs/toolkit/manual/silcmp-silc_mp_div_ui.html new file mode 100644 index 0000000..7b41b7b --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_div_ui.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_div_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_div_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui);
+
+
    +DESCRIPTION + +
    
+    Divide the `mp1' and unsigned word `ui' and save the result to the
+    `dst'. This is equivalent to dst = mp1 / ui;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_gcd.html b/docs/toolkit/manual/silcmp-silc_mp_gcd.html new file mode 100644 index 0000000..aa5f995 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_gcd.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_gcd

    + + +SYNOPSIS + +
    
+    void silc_mp_gcd(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Calculate the greatest common divisor of the integers `mp1' and `mp2'
+    and save the result to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_gcdext.html b/docs/toolkit/manual/silcmp-silc_mp_gcdext.html new file mode 100644 index 0000000..dac6e00 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_gcdext.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_gcdext

    + + +SYNOPSIS + +
    
+    void silc_mp_gcdext(SilcMPInt *g, SilcMPInt *s, SilcMPInt *t,
+                        SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Calculate the extended greatest common divisor `g', `s' and `t' such
+    that g = mp1 * s + mp2 * + t.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_get_str.html b/docs/toolkit/manual/silcmp-silc_mp_get_str.html new file mode 100644 index 0000000..acc00af --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_get_str.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_get_str

    + + +SYNOPSIS + +
    
+    void silc_mp_get_str(char *str, SilcMPInt *mp, int base);
+
+
    +DESCRIPTION + +
    
+    Converts integer `mp' into a string of base `base'. The `str'
+    must already have space allocated. The function returns the same
+    as `str' or NULL on error.
+
+
    +NOTES + +
    
+    For base 2 the returned string is in ASCII bit presentation, not
+    in binary.  Use the silc_mp_mp2bin to encode integer into binary.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_get_ui.html b/docs/toolkit/manual/silcmp-silc_mp_get_ui.html new file mode 100644 index 0000000..b618c28 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_get_ui.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_get_ui

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_mp_get_ui(SilcMPInt *mp);
+
+
    +DESCRIPTION + +
    
+    Returns the least significant unsigned word from `mp'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_init.html b/docs/toolkit/manual/silcmp-silc_mp_init.html new file mode 100644 index 0000000..441d3ad --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_init.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_init

    + + +SYNOPSIS + +
    
+    void silc_mp_init(SilcMPInt mp);
+
+
    +DESCRIPTION + +
    
+    Initializes the SilcMPInt *that is the actual MP Integer.
+    This must be called before any of the silc_mp_ routines can be
+    used. The integer is uninitialized with the silc_mp_uninit function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mod.html b/docs/toolkit/manual/silcmp-silc_mp_mod.html new file mode 100644 index 0000000..5c8e1bf --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mod.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mod

    + + +SYNOPSIS + +
    
+    void silc_mp_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Mathematical MOD function. Produces the remainder of `mp1' and `mp2'
+    and saves the result to `dst'. This is equivalent to dst = mp1 mod mp2.
+    The same result can also be get with silc_mp_div_qr as that function
+    returns the remainder as well.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mod_2exp.html b/docs/toolkit/manual/silcmp-silc_mp_mod_2exp.html new file mode 100644 index 0000000..cefea5a --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mod_2exp.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mod_2exp

    + + +SYNOPSIS + +
    
+    void silc_mp_mod_2exp(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Computes the remainder of `mp1' with 2 ** `exp' and saves the
+    result to `dst'. This is equivalent to dst = mp1 mod (2 ^ exp).
+    The same result can also be get with silc_mp_div_2exp_qr as that
+    function returns the remainder as well.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mod_ui.html b/docs/toolkit/manual/silcmp-silc_mp_mod_ui.html new file mode 100644 index 0000000..11e91a2 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mod_ui.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mod_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui);
+
+
    +DESCRIPTION + +
    
+    Mathematical MOD function. Produces the remainder of `mp1' and
+    unsigned word `ui' and saves the result to `dst'. This is equivalent
+    to dst = mp1 mod ui.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_modinv.html b/docs/toolkit/manual/silcmp-silc_mp_modinv.html new file mode 100644 index 0000000..be46040 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_modinv.html @@ -0,0 +1,271 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_modinv

    + + +SYNOPSIS + +
    
+    void silc_mp_modinv(SilcMPInt *inv, SilcMPInt *a, SilcMPInt *n);
+
+
    +DESCRIPTION + +
    
+    Find multiplicative inverse using Euclid's extended algorithm.
+    Computes inverse such that a * inv mod n = 1, where 0 < a < n.
+    Algorithm goes like this:
+
+    g(0) = n    v(0) = 0
+    g(1) = a    v(1) = 1
+
+    y = g(i-1) / g(i)
+    g(i+1) = g(i-1) - y * g(i) = g(i)-1 mod g(i)
+    v(i+1) = v(i-1) - y * v(i)
+
+    do until g(i) = 0, then inverse = v(i-1). If inverse is negative then n,
+    is added to inverse making it positive again. (Sometimes the algorithm
+    has a variable u defined too and it behaves just like v, except that
+    initalize values are swapped (i.e. u(0) = 1, u(1) = 0). However, u is
+    not needed by the algorithm so it does not have to be included.)
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mp2bin.html b/docs/toolkit/manual/silcmp-silc_mp_mp2bin.html new file mode 100644 index 0000000..02e05af --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mp2bin.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mp2bin

    + + +SYNOPSIS + +
    
+    unsigned char *silc_mp_mp2bin(SilcMPInt *val, SilcUInt32 len,
+                                  SilcUInt32 *ret_len);
+
+
    +DESCRIPTION + +
    
+    Encodes MP integer into binary data. Returns allocated data that
+    must be free'd by the caller. If `len' is provided the destination
+    buffer is allocated that large. If zero then the size is approximated.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mp2bin_noalloc.html b/docs/toolkit/manual/silcmp-silc_mp_mp2bin_noalloc.html new file mode 100644 index 0000000..9287e81 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mp2bin_noalloc.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mp2bin_noalloc

    + + +SYNOPSIS + +
    
+    void silc_mp_mp2bin_noalloc(SilcMPInt *val, unsigned char *dst,
+                                SilcUInt32 dst_len);
+
+
    +DESCRIPTION + +
    
+    Same as silc_mp_mp2bin but does not allocate any memory.  The
+    encoded data is returned into `dst' of size of `dst_len'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mul.html b/docs/toolkit/manual/silcmp-silc_mp_mul.html new file mode 100644 index 0000000..5b31c0b --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mul.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mul

    + + +SYNOPSIS + +
    
+    void silc_mp_mul(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Multiply two integers `mp1' and `mp2' and save the result to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mul_2exp.html b/docs/toolkit/manual/silcmp-silc_mp_mul_2exp.html new file mode 100644 index 0000000..01c75c8 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mul_2exp.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mul_2exp

    + + +SYNOPSIS + +
    
+    void silc_mp_mul_2exp(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp);
+
+
    +DESCRIPTION + +
    
+    Multiply integers `mp1' with 2 ** `exp' and save the result to
+    `dst'. This is equivalent to dst = mp1 * (2 ^ exp).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_mul_ui.html b/docs/toolkit/manual/silcmp-silc_mp_mul_ui.html new file mode 100644 index 0000000..2441d42 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_mul_ui.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_mul_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_mul_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui);
+
+
    +DESCRIPTION + +
    
+    Multiply integer `mp1' and unsigned word `ui' and save the result
+    to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_neg.html b/docs/toolkit/manual/silcmp-silc_mp_neg.html new file mode 100644 index 0000000..5028360 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_neg.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_neg

    + + +SYNOPSIS + +
    
+    void silc_mp_neg(SilcMPInt *dst, SilcMPInt *src);
+
+
    +DESCRIPTION + +
    
+    Negate `src' and save the result to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_or.html b/docs/toolkit/manual/silcmp-silc_mp_or.html new file mode 100644 index 0000000..ba6e5fc --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_or.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_or

    + + +SYNOPSIS + +
    
+    void silc_mp_or(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Logical inclusive OR operator. The result is saved to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_pow.html b/docs/toolkit/manual/silcmp-silc_mp_pow.html new file mode 100644 index 0000000..e308979 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_pow.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_pow

    + + +SYNOPSIS + +
    
+    void silc_mp_pow(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp);
+
+
    +DESCRIPTION + +
    
+    Compute `mp1' ** `exp' and save the result to `dst'. This is
+    equivalent to dst = mp1 ^ exp.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_pow_mod.html b/docs/toolkit/manual/silcmp-silc_mp_pow_mod.html new file mode 100644 index 0000000..51559ff --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_pow_mod.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_pow_mod

    + + +SYNOPSIS + +
    
+    void silc_mp_pow_mod(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *exp,
+                         SilcMPInt *mod);
+
+
    +DESCRIPTION + +
    
+    Compute (`mp1' ** `exp') mod `mod' and save the result to `dst'.
+    This is equivalent to dst = (mp1 ^ exp) mod mod.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_pow_mod_ui.html b/docs/toolkit/manual/silcmp-silc_mp_pow_mod_ui.html new file mode 100644 index 0000000..febd190 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_pow_mod_ui.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_pow_mod_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_pow_mod_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp,
+                            SilcMPInt *mod);
+
+
    +DESCRIPTION + +
    
+    Compute (`mp1' ** `exp') mod `mod' and save the result to `dst'.
+    This is equivalent to dst = (mp1 ^ exp) mod mod.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_pow_ui.html b/docs/toolkit/manual/silcmp-silc_mp_pow_ui.html new file mode 100644 index 0000000..121da74 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_pow_ui.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_pow_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_pow_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 exp);
+
+
    +DESCRIPTION + +
    
+    Compute `mp1' ** `exp' and save the result to `dst'. This is
+    equivalent to dst = mp1 ^ exp.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_set.html b/docs/toolkit/manual/silcmp-silc_mp_set.html new file mode 100644 index 0000000..fa8a2ac --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_set.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_set

    + + +SYNOPSIS + +
    
+    void silc_mp_set(SilcMPInt *dst, SilcMPInt *src);
+
+
    +DESCRIPTION + +
    
+    Set `dst' integer from `src' integer. The `dst' must already be
+    initialized.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_set_si.html b/docs/toolkit/manual/silcmp-silc_mp_set_si.html new file mode 100644 index 0000000..ef9c3d1 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_set_si.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_set_si

    + + +SYNOPSIS + +
    
+    void silc_mp_set_si(SilcMPInt *dst, SilcInt32 si);
+
+
    +DESCRIPTION + +
    
+    Set `dst' integer from single word `si'. The `dst' must
+    already be initialized.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_set_str.html b/docs/toolkit/manual/silcmp-silc_mp_set_str.html new file mode 100644 index 0000000..4dec036 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_set_str.html @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_set_str

    + + +SYNOPSIS + +
    
+    void silc_mp_set_str(SilcMPInt *dst, const char *str, int base);
+
+
    +DESCRIPTION + +
    
+    Set `dst' integer from string `str' of base `base'. The `dst' must
+    already be initialized.
+
+
    +NOTES + +
    
+    For base 2 the string must be in ASCII bit presentation, not in
+    binary.  Use the silc_mp_bin2mp to decode binary into integer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_set_ui.html b/docs/toolkit/manual/silcmp-silc_mp_set_ui.html new file mode 100644 index 0000000..b523cee --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_set_ui.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_set_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_set_ui(SilcMPInt *dst, SilcUInt32 ui);
+
+
    +DESCRIPTION + +
    
+    Set `dst' integer from unsigned word `ui'. The `dst' must already be
+    initialized.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_size.html b/docs/toolkit/manual/silcmp-silc_mp_size.html new file mode 100644 index 0000000..57e07a7 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_size.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_size

    + + +SYNOPSIS + +
    
+    size_t silc_mp_size(SilcMPInt *mp);
+
+
    +DESCRIPTION + +
    
+    Return the precision size of the integer `mp'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_sizeinbase.html b/docs/toolkit/manual/silcmp-silc_mp_sizeinbase.html new file mode 100644 index 0000000..2eab824 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_sizeinbase.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_sizeinbase

    + + +SYNOPSIS + +
    
+    size_t silc_mp_sizeinbase(SilcMPInt *mp, int base);
+
+
    +DESCRIPTION + +
    
+    Return the size of the integer in base `base'.
+
+
    +NOTES + +
    
+    For any other base but 2 this function usually returns only an
+    approximated size in the base.  It is however guaranteed that the
+    the returned size is always at least the size of the integer or
+    larger.
+
+    For base 2 this returns the exact bit-size of the integer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_sqrt.html b/docs/toolkit/manual/silcmp-silc_mp_sqrt.html new file mode 100644 index 0000000..3fcec92 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_sqrt.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_sqrt

    + + +SYNOPSIS + +
    
+    void silc_mp_sqrt(SilcMPInt *dst, SilcMPInt *src);
+
+
    +DESCRIPTION + +
    
+    Compute square root of floor(sqrt(src)) and save the result to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_sub.html b/docs/toolkit/manual/silcmp-silc_mp_sub.html new file mode 100644 index 0000000..5e7fd4b --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_sub.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_sub

    + + +SYNOPSIS + +
    
+    void silc_mp_sub(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Subtract two integers `mp1' and `mp2' and save the result to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_sub_ui.html b/docs/toolkit/manual/silcmp-silc_mp_sub_ui.html new file mode 100644 index 0000000..c187d8e --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_sub_ui.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_sub_ui

    + + +SYNOPSIS + +
    
+    void silc_mp_sub_ui(SilcMPInt *dst, SilcMPInt *mp1, SilcUInt32 ui);
+
+
    +DESCRIPTION + +
    
+    Subtract integers `mp1' and unsigned word `ui' and save the result
+    to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_uninit.html b/docs/toolkit/manual/silcmp-silc_mp_uninit.html new file mode 100644 index 0000000..3039316 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_uninit.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_uninit

    + + +SYNOPSIS + +
    
+    void silc_mp_uninit(SilcMPInt *mp);
+
+
    +DESCRIPTION + +
    
+    Uninitializes the MP Integer.  The pointer may be NULL.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp-silc_mp_xor.html b/docs/toolkit/manual/silcmp-silc_mp_xor.html new file mode 100644 index 0000000..f2605e3 --- /dev/null +++ b/docs/toolkit/manual/silcmp-silc_mp_xor.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mp_xor

    + + +SYNOPSIS + +
    
+    void silc_mp_xor(SilcMPInt *dst, SilcMPInt *mp1, SilcMPInt *mp2);
+
+
    +DESCRIPTION + +
    
+    Logical exclusive OR operator. The result is saved to `dst'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC MP Interface
    +SilcMPInt
    +silc_mp_init
    +silc_mp_uninit
    +silc_mp_size
    +silc_mp_sizeinbase
    +silc_mp_set
    +silc_mp_set_ui
    +silc_mp_set_si
    +silc_mp_set_str
    +silc_mp_get_ui
    +silc_mp_get_str
    +silc_mp_add
    +silc_mp_add_ui
    +silc_mp_sub
    +silc_mp_sub_ui
    +silc_mp_mul
    +silc_mp_mul_ui
    +silc_mp_mul_2exp
    +silc_mp_sqrt
    +silc_mp_div
    +silc_mp_div_ui
    +silc_mp_div_qr
    +silc_mp_div_2exp
    +silc_mp_div_2exp_qr
    +silc_mp_mod
    +silc_mp_mod_ui
    +silc_mp_mod_2exp
    +silc_mp_pow
    +silc_mp_pow_ui
    +silc_mp_pow_mod
    +silc_mp_pow_mod_ui
    +silc_mp_modinv
    +silc_mp_gcd
    +silc_mp_gcdext
    +silc_mp_cmp
    +silc_mp_cmp_si
    +silc_mp_cmp_ui
    +silc_mp_mp2bin
    +silc_mp_mp2bin_noalloc
    +silc_mp_bin2mp
    +silc_mp_abs
    +silc_mp_neg
    +silc_mp_and
    +silc_mp_or
    +silc_mp_xor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp.html b/docs/toolkit/manual/silcmp.html new file mode 100644 index 0000000..78c11f3 --- /dev/null +++ b/docs/toolkit/manual/silcmp.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmp.html + + + + +
    + +SILC MP Interface
    Header: silcmp.h

    + + +DESCRIPTION + +
    
+ SILC MP Library Interface. This interface defines the arbitrary
+ precision arithmetic routines for SILC. The interface is generic but
+ is mainly intended for crypto usage. This interface is used by SILC
+ routines that needs big numbers, such as RSA implementation,
+ Diffie-Hellman implementation etc.
+
+
  • SilcMPInt +
  • silc_mp_init +
  • silc_mp_uninit +
  • silc_mp_size +
  • silc_mp_sizeinbase +
  • silc_mp_set +
  • silc_mp_set_ui +
  • silc_mp_set_si +
  • silc_mp_set_str +
  • silc_mp_get_ui +
  • silc_mp_get_str +
  • silc_mp_add +
  • silc_mp_add_ui +
  • silc_mp_sub +
  • silc_mp_sub_ui +
  • silc_mp_mul +
  • silc_mp_mul_ui +
  • silc_mp_mul_2exp +
  • silc_mp_sqrt +
  • silc_mp_div +
  • silc_mp_div_ui +
  • silc_mp_div_qr +
  • silc_mp_div_2exp +
  • silc_mp_div_2exp_qr +
  • silc_mp_mod +
  • silc_mp_mod_ui +
  • silc_mp_mod_2exp +
  • silc_mp_pow +
  • silc_mp_pow_ui +
  • silc_mp_pow_mod +
  • silc_mp_pow_mod_ui +
  • silc_mp_modinv +
  • silc_mp_gcd +
  • silc_mp_gcdext +
  • silc_mp_cmp +
  • silc_mp_cmp_si +
  • silc_mp_cmp_ui +
  • silc_mp_mp2bin +
  • silc_mp_mp2bin_noalloc +
  • silc_mp_bin2mp +
  • silc_mp_abs +
  • silc_mp_neg +
  • silc_mp_and +
  • silc_mp_or +
  • silc_mp_xor + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmp.xref b/docs/toolkit/manual/silcmp.xref new file mode 100644 index 0000000..abad0bf --- /dev/null +++ b/docs/toolkit/manual/silcmp.xref @@ -0,0 +1,52 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmp.h" "/home/priikone/silc1/doc/toolkit/silcmp.html" 0 + "SILC MP Interface" "/home/priikone/silc1/doc/toolkit/silcmp.html" 1 + "SilcMPInt" "/home/priikone/silc1/doc/toolkit/silcmp.html" 8 + "silc_mp_init" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_uninit" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_size" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_sizeinbase" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_set" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_set_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_set_si" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_set_str" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_get_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_get_str" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_add" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_add_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_sub" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_sub_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mul" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mul_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mul_2exp" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_sqrt" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_div" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_div_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_div_qr" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_div_2exp" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_div_2exp_qr" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mod" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mod_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mod_2exp" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_pow" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_pow_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_pow_mod" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_pow_mod_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_modinv" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_gcd" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_gcdext" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_cmp" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_cmp_si" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_cmp_ui" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mp2bin" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_mp2bin_noalloc" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_bin2mp" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_abs" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_neg" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_and" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_or" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + "silc_mp_xor" "/home/priikone/silc1/doc/toolkit/silcmp.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcmutex-SilcMutex.html b/docs/toolkit/manual/silcmutex-SilcMutex.html new file mode 100644 index 0000000..582278b --- /dev/null +++ b/docs/toolkit/manual/silcmutex-SilcMutex.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcMutex

    + + +NAME + +
    
+    typedef struct SilcMutexStruct *SilcMutex;
+
+
    +DESCRIPTION + +
    
+    This context is the actual SILC Mutex and is allocated
+    by silc_mutex_alloc and given as argument to all silc_mutex_*
+    functions.  It is freed by the silc_mutex_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-SilcRwLock.html b/docs/toolkit/manual/silcmutex-SilcRwLock.html new file mode 100644 index 0000000..b3741d6 --- /dev/null +++ b/docs/toolkit/manual/silcmutex-SilcRwLock.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcRwLock

    + + +NAME + +
    
+    typedef struct SilcRwLockStruct *SilcRwLock;
+
+
    +DESCRIPTION + +
    
+    This context is the actual SILC read/write lock and is allocated
+    by silc_rwlock_alloc and given as argument to all silc_rwlock_*
+    functions.  It is freed by the silc_rwlock_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_mutex_alloc.html b/docs/toolkit/manual/silcmutex-silc_mutex_alloc.html new file mode 100644 index 0000000..80e5a3b --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_mutex_alloc.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mutex_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_mutex_alloc(SilcMutex *mutex);
+
+
    +DESCRIPTION + +
    
+    Allocates SILC Mutex object.  The mutex object must be allocated
+    before it can be used.  It is freed by the silc_mutex_free function.
+    This returns TRUE and allocated mutex in to the `mutex' and FALSE
+    on error.  If threads support is not compiled in this returns FALSE,
+    but should not be considered as an error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_mutex_assert_locked.html b/docs/toolkit/manual/silcmutex-silc_mutex_assert_locked.html new file mode 100644 index 0000000..66c775f --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_mutex_assert_locked.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mutex_assert_locked

    + + +SYNOPSIS + +
    
+    void silc_mutex_assert_locked(SilcMutex mutex);
+
+
    +DESCRIPTION + +
    
+    Asserts that the `mutex' is locked.  It is fatal error if the mutex
+    is not locked.  If debugging is not compiled in this function has
+    no effect (SILC_DEBUG define).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_mutex_free.html b/docs/toolkit/manual/silcmutex-silc_mutex_free.html new file mode 100644 index 0000000..1c35b44 --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_mutex_free.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mutex_free

    + + +SYNOPSIS + +
    
+    void silc_mutex_free(SilcMutex mutex);
+
+
    +DESCRIPTION + +
    
+    Free SILC Mutex object and frees all allocated memory.  If `mutex'
+    is NULL this function has no effect.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_mutex_lock.html b/docs/toolkit/manual/silcmutex-silc_mutex_lock.html new file mode 100644 index 0000000..6ef22b3 --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_mutex_lock.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mutex_lock

    + + +SYNOPSIS + +
    
+    void silc_mutex_lock(SilcMutex mutex);
+
+
    +DESCRIPTION + +
    
+    Locks the mutex. If the mutex is locked by another thread the
+    current thread will block until the other thread has issued
+    silc_mutex_unlock for the mutex.  If `mutex' is NULL this function
+    has no effect.
+
+
    +NOTES + +
    
+    The caller must not call silc_mutex_lock for mutex that has been
+    already locked in the current thread.  In this case deadlock will
+    occur.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_mutex_unlock.html b/docs/toolkit/manual/silcmutex-silc_mutex_unlock.html new file mode 100644 index 0000000..8fa1df7 --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_mutex_unlock.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_mutex_unlock

    + + +SYNOPSIS + +
    
+    void silc_mutex_unlock(SilcMutex mutex);
+
+
    +DESCRIPTION + +
    
+    Unlocks the mutex and thus releases it for another thread that
+    may be waiting for the lock.  If `mutex' is NULL this function
+    has no effect.
+
+
    +NOTES + +
    
+    The caller must not call the silc_mutex_unlock for an unlocked
+    mutex or mutex not locked by the current thread.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_rwlock_alloc.html b/docs/toolkit/manual/silcmutex-silc_rwlock_alloc.html new file mode 100644 index 0000000..e18eb69 --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_rwlock_alloc.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rwlock_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_rwlock_alloc(SilcRwLock *rwlock);
+
+
    +DESCRIPTION + +
    
+    Allocates SILC read/write lock.  The read/write lock must be allocated
+    before it can be used.  It is freed by the silc_rwlock_free function.
+    This returns TRUE and allocated read/write lock in to the `rwlock' and
+    FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_rwlock_free.html b/docs/toolkit/manual/silcmutex-silc_rwlock_free.html new file mode 100644 index 0000000..caf5c8f --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_rwlock_free.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rwlock_free

    + + +SYNOPSIS + +
    
+    void silc_rwlock_free(SilcRwLock rwlock);
+
+
    +DESCRIPTION + +
    
+    Free SILC Rwlock object and frees all allocated memory.  If `rwlock'
+    is NULL this function has no effect.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_rwlock_rdlock.html b/docs/toolkit/manual/silcmutex-silc_rwlock_rdlock.html new file mode 100644 index 0000000..210210a --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_rwlock_rdlock.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rwlock_rdlock

    + + +SYNOPSIS + +
    
+    void silc_rwlock_rdlock(SilcRwLock rwlock);
+
+
    +DESCRIPTION + +
    
+    Acquires read lock of the read/write lock `rwlock'.  If the `rwlock'
+    is locked by a writer the current thread will block until the other
+    thread has issued silc_rwlock_unlock for the `rwlock'.  This function
+    may be called multiple times to acquire the read lock.  There must be
+    same number of silc_rwlock_unlock calls.  If `rwlock' is NULL this
+    function has no effect.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_rwlock_unlock.html b/docs/toolkit/manual/silcmutex-silc_rwlock_unlock.html new file mode 100644 index 0000000..04187cd --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_rwlock_unlock.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rwlock_unlock

    + + +SYNOPSIS + +
    
+    void silc_rwlock_unlock(SilcRwLock rwlock);
+
+
    +DESCRIPTION + +
    
+    Releases the lock of the read/write lock `rwlock'.  If `rwlock' was
+    locked by a writer this will release the writer lock.  Otherwise this
+    releases the reader lock.  If `rwlock' is NULL this function has no
+    effect.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex-silc_rwlock_wrlock.html b/docs/toolkit/manual/silcmutex-silc_rwlock_wrlock.html new file mode 100644 index 0000000..8e548dd --- /dev/null +++ b/docs/toolkit/manual/silcmutex-silc_rwlock_wrlock.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rwlock_wrlock

    + + +SYNOPSIS + +
    
+    void silc_rwlock_wrlock(SilcRwLock rwlock);
+
+
    +DESCRIPTION + +
    
+    Acquires write lock of the read/write lock `rwlock'.  If the `rwlock'
+    is locked by a writer or a reader the current thread will block until
+    the other thread(s) have issued silc_rwlock_unlock for the `rwlock'.
+    A thread may acquire the write lock only once.  A deadlock may occur
+    if thread attempts to acquire the write lock when it has already done
+    so.  If `rwlock' is NULL this function has no effect.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Mutex Interface
    +SilcMutex
    +SilcRwLock
    +silc_mutex_alloc
    +silc_mutex_free
    +silc_mutex_lock
    +silc_mutex_unlock
    +silc_mutex_assert_locked
    +silc_rwlock_alloc
    +silc_rwlock_free
    +silc_rwlock_rdlock
    +silc_rwlock_wrlock
    +silc_rwlock_unlock
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex.html b/docs/toolkit/manual/silcmutex.html new file mode 100644 index 0000000..1ba8969 --- /dev/null +++ b/docs/toolkit/manual/silcmutex.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcmutex.html + + + + +
    + +SILC Mutex Interface
    Header: silcmutex.h

    + + +DESCRIPTION + +
    
+ Interface for mutual exclusion locks and read/write locks.  This is
+ platform independent interface for applications that need concurrency
+ control.
+
+
  • SilcMutex +
  • SilcRwLock +
  • silc_mutex_alloc +
  • silc_mutex_free +
  • silc_mutex_lock +
  • silc_mutex_unlock +
  • silc_mutex_assert_locked +
  • silc_rwlock_alloc +
  • silc_rwlock_free +
  • silc_rwlock_rdlock +
  • silc_rwlock_wrlock +
  • silc_rwlock_unlock + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcmutex.xref b/docs/toolkit/manual/silcmutex.xref new file mode 100644 index 0000000..7802170 --- /dev/null +++ b/docs/toolkit/manual/silcmutex.xref @@ -0,0 +1,19 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcmutex.h" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 0 + "SILC Mutex Interface" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 1 + "SilcMutex" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 5 + "SilcRwLock" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 5 + "silc_mutex_alloc" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_mutex_free" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_mutex_lock" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_mutex_unlock" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_mutex_assert_locked" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_rwlock_alloc" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_rwlock_free" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_rwlock_rdlock" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_rwlock_wrlock" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + "silc_rwlock_unlock" "/home/priikone/silc1/doc/toolkit/silcmutex.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcnet-SilcNetCallback.html b/docs/toolkit/manual/silcnet-SilcNetCallback.html new file mode 100644 index 0000000..30d8528 --- /dev/null +++ b/docs/toolkit/manual/silcnet-SilcNetCallback.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcNetCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcNetCallback)(SilcNetStatus status,
+                                    SilcStream stream, void *context);
+
+
    +DESCRIPTION + +
    
+    A callback of this type is returned by silc_net_tcp_create_listener
+    and silc_net_tcp_connect functions.  For silc_net_tcp_create_listener
+    this callback means that new incoming connection was accepted, and the
+    `stream' is the socket stream representing the socket connection.
+
+    For silc_net_tcp_connect this means that we have connected to the
+    remote host and the `stream' is the socket stream for the socket
+    connection.  The SILC Stream API (such as silc_stream_read, etc.) can
+    be used to read and write to the stream.  The created stream is socket
+    stream so various SilcSocketStream API functions can be used with
+    the `stream'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-SilcNetListener.html b/docs/toolkit/manual/silcnet-SilcNetListener.html new file mode 100644 index 0000000..c29efae --- /dev/null +++ b/docs/toolkit/manual/silcnet-SilcNetListener.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcNetListener

    + + +NAME + +
    
+    typedef struct SilcNetListenerStruct *SilcNetListener;
+
+
    +DESCRIPTION + +
    
+    The network listenr context.  This context is created with the
+    silc_net_create_listener function and destroyed with
+    silc_net_close_listener function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-SilcNetResolveCallback.html b/docs/toolkit/manual/silcnet-SilcNetResolveCallback.html new file mode 100644 index 0000000..a875437 --- /dev/null +++ b/docs/toolkit/manual/silcnet-SilcNetResolveCallback.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcNetResolveCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcNetResolveCallback)(const char *result,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    A callback function of this type is called after the asynchronous
+    resolving operation has been completed.  This callback is used
+    when asynchronously resolving IP addresses and hostnames.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-SilcNetStatus.html b/docs/toolkit/manual/silcnet-SilcNetStatus.html new file mode 100644 index 0000000..52f52ca --- /dev/null +++ b/docs/toolkit/manual/silcnet-SilcNetStatus.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcNetStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcNetStatus;
+
+
    +DESCRIPTION + +
    
+    Status to indicate the result of the network operation creation.  This
+    type is returned in the SilcNetCallback callback function.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_NET_OK,                         /* Everything Ok */
+      SILC_NET_UNKNOWN_IP,                 /* Unknown IP address */
+      SILC_NET_UNKNOWN_HOST,               /* Unknown hostname */
+      SILC_NET_HOST_UNREACHABLE,           /* Destination unreachable */
+      SILC_NET_CONNECTION_REFUSED,         /* Connection refused */
+      SILC_NET_CONNECTION_TIMEOUT,         /* Connection timedout */
+      SILC_NET_NO_MEMORY,                  /* System out of memory */
+      SILC_NET_ERROR,                      /* Unknown error */
+    } SilcNetStatus;
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_accept_connection.html b/docs/toolkit/manual/silcnet-silc_net_accept_connection.html new file mode 100644 index 0000000..a58e53c --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_accept_connection.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_accept_connection

    + + +SYNOPSIS + +
    
+    int silc_net_accept_connection(int sock);
+
+
    +DESCRIPTION + +
    
+    Accepts a connection from a particular socket.  This routine can only
+    be used with POSIX compliant systems.  This call is equivalent to
+    accept(2).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_addr2bin.html b/docs/toolkit/manual/silcnet-silc_net_addr2bin.html new file mode 100644 index 0000000..d9ba6df --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_addr2bin.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_addr2bin

    + + +SYNOPSIS + +
    
+    SilcBool silc_net_addr2bin(const char *addr, void *bin,
+                               SilcUInt32 bin_len);
+
+
    +DESCRIPTION + +
    
+    Converts the IP number string from numbers-and-dots notation to
+    binary form in network byte order.  The address can be either
+    IPv4 or IPv6 address.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_check_host_by_sock.html b/docs/toolkit/manual/silcnet-silc_net_check_host_by_sock.html new file mode 100644 index 0000000..5ea600f --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_check_host_by_sock.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_check_host_by_sock

    + + +SYNOPSIS + +
    
+    SilcBool silc_net_check_host_by_sock(SilcSocket sock, char **hostname,
+                                         char **ip);
+
+
    +DESCRIPTION + +
    
+    Performs lookups for remote name and IP address. This peforms reverse
+    lookup as well to verify that the IP has FQDN.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_check_local_by_sock.html b/docs/toolkit/manual/silcnet-silc_net_check_local_by_sock.html new file mode 100644 index 0000000..cdedea3 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_check_local_by_sock.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_check_local_by_sock

    + + +SYNOPSIS + +
    
+    SilcBool silc_net_check_local_by_sock(SilcSocket sock, char **hostname,
+                                          char **ip);
+
+
    +DESCRIPTION + +
    
+    Performs lookups for local name and IP address. This peforms reverse
+    lookup as well to verify that the IP has FQDN.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_close_connection.html b/docs/toolkit/manual/silcnet-silc_net_close_connection.html new file mode 100644 index 0000000..e74e7cb --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_close_connection.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_close_connection

    + + +SYNOPSIS + +
    
+    void silc_net_close_connection(int sock);
+
+
    +DESCRIPTION + +
    
+    Closes the connection by closing the socket connection.  This routine
+    can only be used with POSIX compliant systems.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_close_listener.html b/docs/toolkit/manual/silcnet-silc_net_close_listener.html new file mode 100644 index 0000000..a8b9489 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_close_listener.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_close_listener

    + + +SYNOPSIS + +
    
+    void silc_net_close_listener(SilcNetListener listener);
+
+
    +DESCRIPTION + +
    
+    Closes the network listener indicated by `listener'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_get_error_string.html b/docs/toolkit/manual/silcnet-silc_net_get_error_string.html new file mode 100644 index 0000000..3a6cde7 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_get_error_string.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_get_error_string

    + + +SYNOPSIS + +
    
+    const char silc_net_get_error_string(SilcNetStatus error);
+
+
    +DESCRIPTION + +
    
+    Return `error' as a string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_get_local_port.html b/docs/toolkit/manual/silcnet-silc_net_get_local_port.html new file mode 100644 index 0000000..a0f710a --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_get_local_port.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_get_local_port

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_net_get_local_port(SilcSocket sock);
+
+
    +DESCRIPTION + +
    
+    Return local port by socket.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_get_remote_port.html b/docs/toolkit/manual/silcnet-silc_net_get_remote_port.html new file mode 100644 index 0000000..85afa8f --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_get_remote_port.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_get_remote_port

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_net_get_remote_port(SilcSocket sock);
+
+
    +DESCRIPTION + +
    
+    Return remote port by socket.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_get_socket_opt.html b/docs/toolkit/manual/silcnet-silc_net_get_socket_opt.html new file mode 100644 index 0000000..6de1331 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_get_socket_opt.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_get_socket_opt

    + + +SYNOPSIS + +
    
+    int silc_net_get_socket_opt(int sock, int level, int option,
+                                void *optval, int *opt_len);
+
+
    +DESCRIPTION + +
    
+    Return socket options to the `optval' and `opt_len'.  This routine
+    can only be used with POSIX compliant systems.  This call is
+    equivalent to getsockopt(2).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_gethostbyaddr.html b/docs/toolkit/manual/silcnet-silc_net_gethostbyaddr.html new file mode 100644 index 0000000..2b82e6c --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_gethostbyaddr.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_gethostbyaddr

    + + +SYNOPSIS + +
    
+   SilcBool silc_net_gethostbyaddr(const char *addr, char *name,
+                                   SilcUInt32 name_len);
+
+ * DESCRIPTION
+
+    Resolves the hostname for the IP address indicated by the `addr'
+    This returns TRUE and the resolved hostname to the `name' buffer,
+    or FALSE on error. The `addr' may be either IPv4 or IPv6 address.
+    This is synchronous function and will block the calling process.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_gethostbyaddr_async.html b/docs/toolkit/manual/silcnet-silc_net_gethostbyaddr_async.html new file mode 100644 index 0000000..ddfa319 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_gethostbyaddr_async.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_gethostbyaddr_async

    + + +SYNOPSIS + +
    
+    void silc_net_gethostbyaddr_async(const char *addr,
+                                      SilcSchedule schedule,
+                                      SilcNetResolveCallback completion,
+                                      void *context)
+
+
    +DESCRIPTION + +
    
+    Asynchronously resolves the hostname for the IP address indicated
+    by the `addr'.  This function returns immediately, and the
+    `completion' callback will be called after the resolving is
+    completed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_gethostbyname.html b/docs/toolkit/manual/silcnet-silc_net_gethostbyname.html new file mode 100644 index 0000000..3a40c05 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_gethostbyname.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_gethostbyname

    + + +SYNOPSIS + +
    
+    SilcBool silc_net_gethostbyname(const char *name, SilcBool prefer_ipv6,
+                                    char *address, SilcUInt32 address_len);
+
+
    +DESCRIPTION + +
    
+    Resolves the IP address of the hostname indicated by the `name'.
+    This returns TRUE and the IP address of the host to the `address'
+    buffer, or FALSE if the address could not be resolved.  This is
+    synchronous function and will block the calling process.  If the
+    `prefer_ipv6' is TRUE then this will return IPv6 address if it
+    finds.  If FALSE if returns IPv4 address even if it found IPv6
+    address also.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_gethostbyname_async.html b/docs/toolkit/manual/silcnet-silc_net_gethostbyname_async.html new file mode 100644 index 0000000..b1a0176 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_gethostbyname_async.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_gethostbyname_async

    + + +SYNOPSIS + +
    
+    void silc_net_gethostbyname_async(const char *name,
+                                      SilcBool prefer_ipv6,
+                                      SilcSchedule schedule,
+                                      SilcNetResolveCallback completion,
+                                      void *context)
+
+
    +DESCRIPTION + +
    
+    Asynchronously resolves the IP address of the hostname indicated
+    by the `name'.  This function returns immediately, and the
+    `completion' callback will be called after the resolving is
+    completed.
+
+    If the `prefer_ipv6' is TRUE then this will return IPv6 address if it
+    finds.  If FALSE if returns IPv4 address even if it found IPv6
+    address also.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_is_ip.html b/docs/toolkit/manual/silcnet-silc_net_is_ip.html new file mode 100644 index 0000000..d41c2c3 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_is_ip.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_is_ip

    + + +SYNOPSIS + +
    
+    SilcBool silc_net_is_ip(const char *addr);
+
+
    +DESCRIPTION + +
    
+    Checks whether IP address sent as argument is valid IP address.
+    This supports both IPv4 and IPv6 addresses.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_is_ip4.html b/docs/toolkit/manual/silcnet-silc_net_is_ip4.html new file mode 100644 index 0000000..fa46b44 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_is_ip4.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_is_ip4

    + + +SYNOPSIS + +
    
+    SilcBool silc_net_is_ip4(const char *addr);
+
+
    +DESCRIPTION + +
    
+    Checks whether IP address sent as argument is valid IPv4 address.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_is_ip6.html b/docs/toolkit/manual/silcnet-silc_net_is_ip6.html new file mode 100644 index 0000000..5b23dad --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_is_ip6.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_is_ip6

    + + +SYNOPSIS + +
    
+    SilcBool silc_net_is_ip6(const char *addr);
+
+
    +DESCRIPTION + +
    
+    Checks whether IP address sent as argument is valid IPv6 address.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_listener_get_hostname.html b/docs/toolkit/manual/silcnet-silc_net_listener_get_hostname.html new file mode 100644 index 0000000..d80bca4 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_listener_get_hostname.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_listener_get_hostname

    + + +SYNOPSIS + +
    
+    char **silc_net_listener_get_hostname(SilcNetListener listener,
+                                          SilcUInt32 *hostname_count);
+
+
    +DESCRIPTION + +
    
+    Returns the hostnames to where the `listener' is bound.  Returns an
+    array of hostnames of size of `port_count'.  The caller must free the
+    array and its strings with silc_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_listener_get_ip.html b/docs/toolkit/manual/silcnet-silc_net_listener_get_ip.html new file mode 100644 index 0000000..5ade8c1 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_listener_get_ip.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_listener_get_ip

    + + +SYNOPSIS + +
    
+    char **silc_net_listener_get_ip(SilcNetListener listener,
+                                    SilcUInt32 *ip_count);
+
+
    +DESCRIPTION + +
    
+    Returns the IP's to where the `listener' is bound.  Returns an array
+    of IP addresses of size of `port_count'.  The caller must free the
+    array and its strings with silc_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_listener_get_port.html b/docs/toolkit/manual/silcnet-silc_net_listener_get_port.html new file mode 100644 index 0000000..ba2e6b3 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_listener_get_port.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_listener_get_port

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_net_listener_get_port(SilcNetListener listener);
+
+
    +DESCRIPTION + +
    
+    Returns the ports to where the `listener' is bound.  This can be used
+    to get the port if none was specified in silc_net_tcp_create_listener.
+    Returns an array of ports of size of `port_count'.  The caller must
+    free the array with silc_free.  There are as many ports in the array
+    as there were IP addresses provided in silc_net_tcp_create_listener.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_localhost.html b/docs/toolkit/manual/silcnet-silc_net_localhost.html new file mode 100644 index 0000000..c69f1c0 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_localhost.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_localhost

    + + +SYNOPSIS + +
    
+    char *silc_net_localhost(void);
+
+
    +DESCRIPTION + +
    
+    Return name of localhost.  This will also attempt to resolve
+    the real hostname by the local host's IP address.  If unsuccessful
+    the first found hostname is returned.  The caller must free
+    returned hostname.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_localip.html b/docs/toolkit/manual/silcnet-silc_net_localip.html new file mode 100644 index 0000000..3b169c9 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_localip.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_localip

    + + +SYNOPSIS + +
    
+    char *silc_net_localip(void)
+
+
    +DESCRIPTION + +
    
+    Return IP of localhost.  The caller must free the returned IP.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_set_socket_nonblock.html b/docs/toolkit/manual/silcnet-silc_net_set_socket_nonblock.html new file mode 100644 index 0000000..00c3c2d --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_set_socket_nonblock.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_set_socket_nonblock

    + + +SYNOPSIS + +
    
+    int silc_net_set_socket_nonblock(SilcSocket sock);
+
+
    +DESCRIPTION + +
    
+    Sets the socket `sock' to non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_set_socket_opt.html b/docs/toolkit/manual/silcnet-silc_net_set_socket_opt.html new file mode 100644 index 0000000..37e74f0 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_set_socket_opt.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_set_socket_opt

    + + +SYNOPSIS + +
    
+    int silc_net_set_socket_opt(int sock, int level, int option, int on);
+
+
    +DESCRIPTION + +
    
+    Sets a option for a socket.  This function can be used to set
+    various options for the socket.  Some of the options might be
+    system specific.  This routine can only be used with POSIX compliant
+    systems.  This call is equivalent to setsockopt(2);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_tcp_connect.html b/docs/toolkit/manual/silcnet-silc_net_tcp_connect.html new file mode 100644 index 0000000..315297a --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_tcp_connect.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_tcp_connect

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation silc_net_tcp_connect(const char *local_ip_addr,
+                                            const char *remote_ip_addr,
+                                            int remote_port,
+                                            SilcSchedule schedule,
+                                            SilcNetCallback callback,
+                                            void *context);
+
+
    +DESCRIPTION + +
    
+    Creates TCP/IP connection to the remote host indicated by `remote_host'
+    which may be hostname or IP address, on the port indicated by
+    `remote_port'.  If the `local_ip_addr' is provided the local host is
+    bound to that address before creating the connection.  This is
+    asynchronous call, and this function returns before the connection is
+    actually established.  The `callback' will be called after the
+    connection is created to deliver the SilcStream for the created
+    connection.  This function supports IPv6 if the platform supports it.
+
+    The returned SilcAsyncOperation context can be used to control the
+    asynchronous connecting, such as to abort it.  If it is aborted
+    using silc_async_abort the `callback' will not be called.  If NULL
+    is returned the operation cannot be aborted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_tcp_create_listener.html b/docs/toolkit/manual/silcnet-silc_net_tcp_create_listener.html new file mode 100644 index 0000000..a2d37ea --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_tcp_create_listener.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_tcp_create_listener

    + + +SYNOPSIS + +
    
+    SilcNetListener
+    silc_net_tcp_create_listener(const char **local_ip_addr,
+                                 SilcUInt32 local_ip_count, int port,
+                                 SilcBool lookup, SilcBool require_fqdn,
+                                 SilcSchedule schedule,
+                                 SilcNetCallback callback, void *context);
+
+
    +DESCRIPTION + +
    
+    This function creates TCP listener.  This is used to create network
+    listener for incoming connections, and `callback' will be called
+    everytime new connection is received.  If `local_ip_addr' is NULL 'any'
+    address is used.  If provided it can be used bind the listener to
+    `local_ip_count' many IP addresses provided in `local_ip_addr' table.
+    On success returns the SilcNetListener context, or NULL on error.
+    If `require_fqdn' is TRUE the listener will require that the incoming
+    connection has FQDN to be able to connect.  If the `lookup' is TRUE
+    then the incoming connection hostname will be resolved.  If the `port'
+    is zero (0), operating system will define it automatically.
+
+    The `callback' always delivers valid new stream.  It is not called
+    with an error status.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_udp_connect.html b/docs/toolkit/manual/silcnet-silc_net_udp_connect.html new file mode 100644 index 0000000..6f0a2cf --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_udp_connect.html @@ -0,0 +1,284 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_udp_connect

    + + +SYNOPSIS + +
    
+    SilcStream
+    silc_net_udp_connect(const char *local_ip_addr, int local_port,
+                         const char *remote_ip_addr, int remote_port,
+                         SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    This function creates UDP stream.  The UDP stream is bound to the
+    `local_ip_addr' if it is specified.  If `local_port' is non-zero the
+    stream is bound to that port.  If the `remote_ip_addr' and `remote_port'
+    is also provided, packets may be sent to that address using
+    silc_stream_write function and packets may be received using
+    silc_stream_read function.
+
+    If the remote address is not provided the stream is in connectionless
+    state.  This means that packets can be received only by using
+    silc_net_udp_receive and sent only by using the function
+    silc_net_udp_send.
+
+    To receive packets the silc_stream_set_notifier must be called for the
+    returned SilcStream.  The packets are always received in the notifier
+    callback when the SILC_STREAM_CAN_READ is returned to the callback
+    To read the packet use silc_stream_read if the remote address was
+    provided, and silc_net_udp_receive if it was not.
+
+    Supports IPv6 if the platform supports it.
+
+
    +EXAMPLE + +
    
+    SilcStream udpstream;
+
+    // Create UDP stream and prepare to receive packets
+    udpstream = silc_net_udp_connect("10.2.1.7", 5000,
+                                     "10.2.1.100, 5000, schedule);
+    silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
+
+    // Send packet to remote host
+    silc_stream_write(udpstream, data, data_len);
+
+    Create UDP listener:
+
+    udpstream = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
+    silc_stream_set_notifier(udpstream, schedule, receive_callback, context);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_udp_receive.html b/docs/toolkit/manual/silcnet-silc_net_udp_receive.html new file mode 100644 index 0000000..0a05493 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_udp_receive.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_udp_receive

    + + +SYNOPSIS + +
    
+    int
+    silc_net_udp_receive(SilcStream stream, char *remote_ip_addr,
+                         SilcUInt32 remote_ip_addr_size, int *remote_port,
+                         unsigned char *ret_data, SilcUInt32 data_size)
+
+
    +DESCRIPTION + +
    
+    Receive a UDP packet from the `stream'.  The IP address and port of
+    the sender is returned into `remote_ip_addr' buffer and `remote_port'
+    pointer.  The packet data is returned into the `ret_data' buffer.
+
+    Returns the length of the packet, or -1 on error or 0 in case of EOF.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet-silc_net_udp_send.html b/docs/toolkit/manual/silcnet-silc_net_udp_send.html new file mode 100644 index 0000000..55c3422 --- /dev/null +++ b/docs/toolkit/manual/silcnet-silc_net_udp_send.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_net_udp_send

    + + +SYNOPSIS + +
    
+    int silc_net_udp_send(SilcStream stream,
+                          const char *remote_ip_addr, int remote_port,
+                          const unsigned char *data, SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Sends an UDP packet to remote host `remote_ip_addr' on `remote_port'.
+    This may be used with UDP streams that are not connected to any
+    specific remote host.  With those stream silc_stream_write cannot be
+    used.  In those cases, this function must be used.  This may also be
+    used even if the stream is connected.
+
+    Returns the amount of data written, -1 if data could not be written
+    at this moment, or -2 if error occurred.  If -1 is returned the
+    notifier callback will later be called with SILC_STREAM_CAN_WRITE
+    status when stream is again ready for writing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Net Interface
    +SilcNetListener
    +SilcNetStatus
    +SilcNetCallback
    +silc_net_tcp_create_listener
    +silc_net_listener_get_port
    +silc_net_listener_get_ip
    +silc_net_listener_get_hostname
    +silc_net_close_listener
    +silc_net_tcp_connect
    +silc_net_udp_connect
    +silc_net_udp_receive
    +silc_net_udp_send
    +silc_net_get_error_string
    +silc_net_close_connection
    +silc_net_accept_connection
    +silc_net_set_socket_opt
    +silc_net_get_socket_opt
    +silc_net_set_socket_nonblock
    +silc_net_is_ip4
    +silc_net_is_ip6
    +silc_net_is_ip
    +silc_net_addr2bin
    +SilcNetResolveCallback
    +silc_net_gethostbyname
    +silc_net_gethostbyname_async
    +silc_net_gethostbyaddr
    +silc_net_gethostbyaddr_async
    +silc_net_check_host_by_sock
    +silc_net_check_local_by_sock
    +silc_net_get_remote_port
    +silc_net_get_local_port
    +silc_net_localhost
    +silc_net_localip
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet.html b/docs/toolkit/manual/silcnet.html new file mode 100644 index 0000000..91ddbbe --- /dev/null +++ b/docs/toolkit/manual/silcnet.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcnet.html + + + + +
    + +SILC Net Interface
    Header: silcnet.h

    + + +DESCRIPTION + +
    
+ SILC Net API provides various network routines for applications. It
+ can be used to create TCP/IP and UDP/IP connections and listeners.
+ Various utility functions for resolving various information is also
+ provided.
+
+
  • SilcNetListener +
  • SilcNetStatus +
  • SilcNetCallback +
  • silc_net_tcp_create_listener +
  • silc_net_listener_get_port +
  • silc_net_listener_get_ip +
  • silc_net_listener_get_hostname +
  • silc_net_close_listener +
  • silc_net_tcp_connect +
  • silc_net_udp_connect +
  • silc_net_udp_receive +
  • silc_net_udp_send +
  • silc_net_get_error_string +
  • silc_net_close_connection +
  • silc_net_accept_connection +
  • silc_net_set_socket_opt +
  • silc_net_get_socket_opt +
  • silc_net_set_socket_nonblock +
  • silc_net_is_ip4 +
  • silc_net_is_ip6 +
  • silc_net_is_ip +
  • silc_net_addr2bin +
  • SilcNetResolveCallback +
  • silc_net_gethostbyname +
  • silc_net_gethostbyname_async +
  • silc_net_gethostbyaddr +
  • silc_net_gethostbyaddr_async +
  • silc_net_check_host_by_sock +
  • silc_net_check_local_by_sock +
  • silc_net_get_remote_port +
  • silc_net_get_local_port +
  • silc_net_localhost +
  • silc_net_localip + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet.xref b/docs/toolkit/manual/silcnet.xref new file mode 100644 index 0000000..e53d12f --- /dev/null +++ b/docs/toolkit/manual/silcnet.xref @@ -0,0 +1,40 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcnet.h" "/home/priikone/silc1/doc/toolkit/silcnet.html" 0 + "SILC Net Interface" "/home/priikone/silc1/doc/toolkit/silcnet.html" 1 + "SilcNetListener" "/home/priikone/silc1/doc/toolkit/silcnet.html" 5 + "SilcNetStatus" "/home/priikone/silc1/doc/toolkit/silcnet.html" 8 + "SilcNetCallback" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_tcp_create_listener" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_listener_get_port" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_listener_get_ip" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_listener_get_hostname" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_close_listener" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_tcp_connect" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_udp_connect" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_udp_receive" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_udp_send" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_get_error_string" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_close_connection" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_accept_connection" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_set_socket_opt" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_get_socket_opt" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_set_socket_nonblock" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_is_ip4" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_is_ip6" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_is_ip" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_addr2bin" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "SilcNetResolveCallback" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_gethostbyname" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_gethostbyname_async" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_gethostbyaddr" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_gethostbyaddr_async" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_check_host_by_sock" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_check_local_by_sock" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_get_remote_port" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_get_local_port" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_localhost" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + "silc_net_localip" "/home/priikone/silc1/doc/toolkit/silcnet.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcnet_i.html b/docs/toolkit/manual/silcnet_i.html new file mode 100644 index 0000000..690eff2 --- /dev/null +++ b/docs/toolkit/manual/silcnet_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcnet_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnet_i.xref b/docs/toolkit/manual/silcnet_i.xref new file mode 100644 index 0000000..6415ad3 --- /dev/null +++ b/docs/toolkit/manual/silcnet_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcnet_i.h" "/home/priikone/silc1/doc/toolkit/silcnet_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcnotify-SilcNotifyPayload.html b/docs/toolkit/manual/silcnotify-SilcNotifyPayload.html new file mode 100644 index 0000000..4e57780 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-SilcNotifyPayload.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcNotifyPayload

    + + +NAME + +
    
+    typedef struct SilcNotifyPayloadStruct *SilcNotifyPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Notify Payload and is allocated
+    by silc_notify_payload_parse and given as argument usually to
+    all silc_notify_payload_* functions.  It is freed by the
+    silc_notify_payload_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-SilcNotifyType.html b/docs/toolkit/manual/silcnotify-SilcNotifyType.html new file mode 100644 index 0000000..b405c29 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-SilcNotifyType.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcNotifyType

    + + +NAME + +
    
+    typedef SilcUInt16 SilcNotifyType;
+
+
    +DESCRIPTION + +
    
+    The notify type definition and all of the notify types.
+
+
    +SOURCE + +
        typedef SilcUInt16 SilcNotifyType;
+    
+    /* SILC notify types. Server may send these notify types to client to
+       notify of some action. */
+    #define SILC_NOTIFY_TYPE_NONE            0  /* no specific type */
+    #define SILC_NOTIFY_TYPE_INVITE          1  /* invites/invite list change */
+    #define SILC_NOTIFY_TYPE_JOIN            2  /* "has joined channel" */
+    #define SILC_NOTIFY_TYPE_LEAVE           3  /* "has left channel" */
+    #define SILC_NOTIFY_TYPE_SIGNOFF         4  /* "signoff" */
+    #define SILC_NOTIFY_TYPE_TOPIC_SET       5  /* "topic has been changed" */
+    #define SILC_NOTIFY_TYPE_NICK_CHANGE     6  /* "has changed nickname" */
+    #define SILC_NOTIFY_TYPE_CMODE_CHANGE    7  /* "has changed channel mode" */
+    #define SILC_NOTIFY_TYPE_CUMODE_CHANGE   8  /* "has change mode" */
+    #define SILC_NOTIFY_TYPE_MOTD            9  /* message of the day */
+    #define SILC_NOTIFY_TYPE_CHANNEL_CHANGE  10 /* Channel's ID has changed */
+    #define SILC_NOTIFY_TYPE_SERVER_SIGNOFF  11 /* Server quitting SILC */
+    #define SILC_NOTIFY_TYPE_KICKED          12 /* Kicked from channel */
+    #define SILC_NOTIFY_TYPE_KILLED          13 /* Killed from the network */
+    #define SILC_NOTIFY_TYPE_UMODE_CHANGE    14 /* user mode was changed */
+    #define SILC_NOTIFY_TYPE_BAN             15 /* ban list change */
+    #define SILC_NOTIFY_TYPE_ERROR           16 /* error notify */
+    #define SILC_NOTIFY_TYPE_WATCH           17 /* watch notify */
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-silc_notify_get_arg_num.html b/docs/toolkit/manual/silcnotify-silc_notify_get_arg_num.html new file mode 100644 index 0000000..3ecd739 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-silc_notify_get_arg_num.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_notify_get_arg_num

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_notify_get_arg_num(SilcNotifyPayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the number of the arguments associated with the Notify Payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-silc_notify_get_args.html b/docs/toolkit/manual/silcnotify-silc_notify_get_args.html new file mode 100644 index 0000000..a917a59 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-silc_notify_get_args.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_notify_get_args

    + + +SYNOPSIS + +
    
+    SilcArgumentPayload silc_notify_get_args(SilcNotifyPayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the Argument Payload containing the arguments from the
+    Notify Payload. The caller must not free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-silc_notify_get_type.html b/docs/toolkit/manual/silcnotify-silc_notify_get_type.html new file mode 100644 index 0000000..f26f847 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-silc_notify_get_type.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_notify_get_type

    + + +SYNOPSIS + +
    
+    SilcNotifyType silc_notify_get_type(SilcNotifyPayload payload);
+
+
    +DESCRIPTION + +
    
+    Return the notify type from the payload.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-silc_notify_payload_encode.html b/docs/toolkit/manual/silcnotify-silc_notify_payload_encode.html new file mode 100644 index 0000000..5290ecc --- /dev/null +++ b/docs/toolkit/manual/silcnotify-silc_notify_payload_encode.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_notify_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_notify_payload_encode(SilcNotifyType type,
+                                          SilcUInt32 argc,
+                                          va_list ap);
+
+
    +DESCRIPTION + +
    
+    Encode notify payload with variable argument list. If `argc' is > 0
+    argument payloads will be associated to the notify payload. Variable
+    arguments must be {unsigned char *, SilcUInt32 (len)}.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-silc_notify_payload_encode_args.html b/docs/toolkit/manual/silcnotify-silc_notify_payload_encode_args.html new file mode 100644 index 0000000..91bd6a3 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-silc_notify_payload_encode_args.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_notify_payload_encode_args

    + + +SYNOPSIS + +
    
+    SilcBuffer silc_notify_payload_encode_args(SilcNotifyType type,
+                                               SilcUInt32 argc,
+                                               SilcBuffer args);
+
+
    +DESCRIPTION + +
    
+    Same as silc_notify_payload_encode but takes arguments from the `args'
+    encoded Argument Payload buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-silc_notify_payload_free.html b/docs/toolkit/manual/silcnotify-silc_notify_payload_free.html new file mode 100644 index 0000000..55f4635 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-silc_notify_payload_free.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_notify_payload_free

    + + +SYNOPSIS + +
    
+    void silc_notify_payload_free(SilcNotifyPayload payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Notify Payload and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify-silc_notify_payload_parse.html b/docs/toolkit/manual/silcnotify-silc_notify_payload_parse.html new file mode 100644 index 0000000..9e9e9a1 --- /dev/null +++ b/docs/toolkit/manual/silcnotify-silc_notify_payload_parse.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_notify_payload_parse

    + + +SYNOPSIS + +
    
+    SilcNotifyPayload
+    silc_notify_payload_parse(const unsigned char *payload,
+                              SilcUInt32 payload_len);
+
+
    +DESCRIPTION + +
    
+    Parse notify payload buffer and return data into payload structure.
+    The `buffer' is the raw payload data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Notify Interface
    +SilcNotifyPayload
    +SilcNotifyType
    +silc_notify_payload_parse
    +silc_notify_payload_encode
    +silc_notify_payload_encode_args
    +silc_notify_payload_free
    +silc_notify_get_type
    +silc_notify_get_arg_num
    +silc_notify_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify.html b/docs/toolkit/manual/silcnotify.html new file mode 100644 index 0000000..42f2e2e --- /dev/null +++ b/docs/toolkit/manual/silcnotify.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcnotify.html + + + + +
    + +SILC Notify Interface
    Header: silcnotify.h

    + + +DESCRIPTION + +
    
+ Implementation of the Notify Payload. Notify Payload is used usually
+ by servers to send different kind of important notify messages to other
+ servers and to clients.
+
+
  • SilcNotifyPayload +
  • SilcNotifyType +
  • silc_notify_payload_parse +
  • silc_notify_payload_encode +
  • silc_notify_payload_encode_args +
  • silc_notify_payload_free +
  • silc_notify_get_type +
  • silc_notify_get_arg_num +
  • silc_notify_get_args + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcnotify.xref b/docs/toolkit/manual/silcnotify.xref new file mode 100644 index 0000000..ba4b583 --- /dev/null +++ b/docs/toolkit/manual/silcnotify.xref @@ -0,0 +1,16 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcnotify.h" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 0 + "SILC Notify Interface" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 1 + "SilcNotifyPayload" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 5 + "SilcNotifyType" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 8 + "silc_notify_payload_parse" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 4 + "silc_notify_payload_encode" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 4 + "silc_notify_payload_encode_args" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 4 + "silc_notify_payload_free" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 4 + "silc_notify_get_type" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 4 + "silc_notify_get_arg_num" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 4 + "silc_notify_get_args" "/home/priikone/silc1/doc/toolkit/silcnotify.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcpacket-SilcPacket.html b/docs/toolkit/manual/silcpacket-SilcPacket.html new file mode 100644 index 0000000..cab469a --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacket.html @@ -0,0 +1,284 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPacket

    + + +NAME + +
    
+    typedef struct SilcPacketStruct *SilcPacket;
+
+
    +DESCRIPTION + +
    
+    The SilcPacket is returned by the packet engine in the SilcPacketReceive
+    callback.  The application can parse the data payload from the
+    SilcPacket.  Also packet type, flags, and sender and destination
+    IDs are available.  The application must free the packet with the
+    silc_packet_free function if it takes it in for processing.
+
+    The `buffer' field contains the parsed packet payload and the start
+    of the data area will point to the start of the packet payload.
+
+    The list pointer `next' can be used by the application to put the
+    packet context in a list during processing, if needed.
+
+
    +SOURCE + +
        typedef struct SilcPacketStruct {
+      struct SilcPacketStruct *next;     /* List pointer, application may set */
+      SilcPacketStream stream;           /* Packet stream this packet is from */
+      SilcBufferStruct buffer;           /* Packet data payload */
+      unsigned char *src_id;             /* Source ID */
+      unsigned char *dst_id;             /* Destination ID */
+      unsigned int src_id_len  : 6;      /* Source ID length */
+      unsigned int src_id_type : 2;      /* Source ID type */
+      unsigned int dst_id_len  : 6;      /* Destination ID length */
+      unsigned int dst_id_type : 2;      /* Destination ID type */
+      SilcPacketType type;               /* Packet type */
+      SilcPacketFlags flags;             /* Packet flags */
+    } *SilcPacket;
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketCallbacks.html b/docs/toolkit/manual/silcpacket-SilcPacketCallbacks.html new file mode 100644 index 0000000..9ef9a74 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketCallbacks.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPacketCallbacks

    + + +NAME + +
    
+    typedef struct { ... } *SilcPacketCallbacks;
+
+
    +DESCRIPTION + +
    
+    This structure is sent as argument to the silc_packet_engine_start
+    function to set the callback functions for the packet engine.  The
+    packet engine will call the callbacks when necessary.  Application
+    must always be provided for the packet engine.
+
+
    +SOURCE + +
        typedef struct {
+      SilcPacketReceiveCb packet_receive;    /* Called when packet is received */
+      SilcPacketEosCb eos;                   /* Called on end of stream */
+      SilcPacketErrorCb error;               /* Called on an error */
+    } SilcPacketCallbacks;
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketEngine.html b/docs/toolkit/manual/silcpacket-SilcPacketEngine.html new file mode 100644 index 0000000..a4719b8 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketEngine.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPacketEngine

    + + +NAME + +
    
+    typedef struct SilcPacketEngineStruct *SilcPacketEngine;
+
+
    +DESCRIPTION + +
    
+    The packet engine context, allocated by silc_packet_engine_start.
+    The engine is destroyed with silc_packet_engine_stop.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketEosCb.html b/docs/toolkit/manual/silcpacket-SilcPacketEosCb.html new file mode 100644 index 0000000..0612efd --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketEosCb.html @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcPacketEosCb

    + + +SYNOPSIS + +
    
+    typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
+                                    SilcPacketStream stream,
+                                    void *callback_context,
+                                    void *stream_context);
+
+
    +DESCRIPTION + +
    
+    The End Of Stream (EOS) callback, that is called by the packet engine
+    when the underlaying stream has ended.  No more data can be sent to
+    the stream or read from it.  The `stream' must be destroyed by
+    calling the silc_packet_stream_destroy.  This callback is set in the
+    SilcPacketCallbacks structure.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketError.html b/docs/toolkit/manual/silcpacket-SilcPacketError.html new file mode 100644 index 0000000..2c4fcd2 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketError.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcPacketError

    + + +NAME + +
    
+    typedef enum { ... } SilcPacketError
+
+
    +DESCRIPTION + +
    
+    Packet errors.  This is returned in the error callback.  If application
+    needs the actual lower level stream error, it needs to retrieve it
+    from the actual stream.  It can retrieve the underlaying stream from
+    the packet stream by calling silc_packet_stream_get_stream function.
+
+    You may retrieve string version of the SilcPacketError by calling
+    silc_packet_error_string.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_PACKET_ERR_READ,                  /* Error while reading */
+      SILC_PACKET_ERR_WRITE,                 /* Error while writing */
+      SILC_PACKET_ERR_MAC_FAILED,            /* Packet MAC check failed */
+      SILC_PACKET_ERR_DECRYPTION_FAILED,     /* Packet decryption failed */
+      SILC_PACKET_ERR_UNKNOWN_SID,           /* Unknown SID (with IV included) */
+      SILC_PACKET_ERR_MALFORMED,             /* Packet is malformed */
+      SILC_PACKET_ERR_NO_MEMORY,             /* System out of memory */
+    } SilcPacketError;
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketErrorCb.html b/docs/toolkit/manual/silcpacket-SilcPacketErrorCb.html new file mode 100644 index 0000000..df60e99 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketErrorCb.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcPacketErrorCb

    + + +SYNOPSIS + +
    
+    typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
+                                      SilcPacketStream stream,
+                                      SilcPacketError error,
+                                      void *callback_context,
+                                      void *stream_context);
+
+
    +DESCRIPTION + +
    
+    The error callback that is called by the packet engine if an error
+    occurs.  The `error' will indicate the error.  This callback is set
+    in the SilcPacketCallbacks structure.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketFlags.html b/docs/toolkit/manual/silcpacket-SilcPacketFlags.html new file mode 100644 index 0000000..b720f93 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketFlags.html @@ -0,0 +1,273 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcPacketFlags

    + + +NAME + +
    
+    typedef SilcUInt8 SilcPacketFlags;
+
+
    +DESCRIPTION + +
    
+    SILC packet flags type definition and all the packet flags.
+
+
    +SOURCE + +
        typedef SilcUInt8 SilcPacketFlags;
+    
+    /* All defined packet flags */
+    #define SILC_PACKET_FLAG_NONE             0x00    /* No flags */
+    #define SILC_PACKET_FLAG_PRIVMSG_KEY      0x01    /* Private message key */
+    #define SILC_PACKET_FLAG_LIST             0x02    /* Packet is a list */
+    #define SILC_PACKET_FLAG_BROADCAST        0x04    /* Packet is a broadcast */
+    #define SILC_PACKET_FLAG_COMPRESSED       0x08    /* Payload is compressed */
+    #define SILC_PACKET_FLAG_ACK              0x10    /* Acknowledge packet */
+    
+    /* Impelemntation specific flags */
+    #define SILC_PACKET_FLAG_LONG_PAD         0x20    /* Use maximum padding */
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketReceiveCb.html b/docs/toolkit/manual/silcpacket-SilcPacketReceiveCb.html new file mode 100644 index 0000000..428029b --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketReceiveCb.html @@ -0,0 +1,297 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcPacketReceiveCb

    + + +SYNOPSIS + +
    
+    typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
+                                            SilcPacketStream stream,
+                                            SilcPacket packet,
+                                            void *callback_context,
+                                            void *stream_context);
+
+
    +DESCRIPTION + +
    
+    The packet receive callback is called by the packet engine when a new
+    SILC Packet has arrived.  The application must free the returned
+    SilcPacket with silc_packet_free if it takes the packet in for
+    processing.  This callback is set in the SilcPacketCallbacks structure.
+    The `callback_context' is the context set as argument in the
+    silc_packet_engine_start function.  The `stream_context' is stream
+    specific context that was set by calling silc_packet_set_context.
+
+    If the application takes the received packet `packet' into processing
+    TRUE must be returned.  If FALSE is returned the packet engine will
+    pass the packet to other packet processor, if one has been linked
+    to the stream with silc_packet_stream_link function.  If no extra
+    processor is linked the packet is dropped.
+
+
    +EXAMPLE + +
    
+    SilcBool
+    silc_foo_packet_receive_cb(SilcPacketEngine engine,
+                               SilcPacketStream stream, SilcPacket packet,
+                               void *callback_context, void *stream_context)
+    {
+      Application ctx = callback_context;
+
+      // If we're not up yet, let's not process the packet
+      if (ctx->initialized == FALSE)
+        return FALSE;
+
+      // Process the incoming packet...
+      ...
+
+      // It's our packet now, no one else will get it
+      return TRUE;
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketStream.html b/docs/toolkit/manual/silcpacket-SilcPacketStream.html new file mode 100644 index 0000000..1c3ace6 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketStream.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPacketStream

    + + +NAME + +
    
+    typedef struct SilcPacketStreamStruct *SilcPacketStream;
+
+
    +DESCRIPTION + +
    
+    The packet stream context, allocated by silc_packet_stream_create.
+    The stream is destroyed with silc_packet_stream_destroy.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketType.html b/docs/toolkit/manual/silcpacket-SilcPacketType.html new file mode 100644 index 0000000..ab67f05 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketType.html @@ -0,0 +1,299 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcPacketType

    + + +NAME + +
    
+    typedef SilcUInt8 SilcPacketType;
+
+
    +DESCRIPTION + +
    
+    SILC packet type definition and all the packet types.
+
+
    +SOURCE + +
        typedef SilcUInt8 SilcPacketType;
+    
+    /* SILC Packet types. */
+    #define SILC_PACKET_DISCONNECT           1       /* Disconnection */
+    #define SILC_PACKET_SUCCESS              2       /* Success */
+    #define SILC_PACKET_FAILURE              3       /* Failure */
+    #define SILC_PACKET_REJECT               4       /* Rejected */
+    #define SILC_PACKET_NOTIFY               5       /* Notify message */
+    #define SILC_PACKET_ERROR                6       /* Error message */
+    #define SILC_PACKET_CHANNEL_MESSAGE      7       /* Message for channel */
+    #define SILC_PACKET_CHANNEL_KEY          8       /* Key of the channel */
+    #define SILC_PACKET_PRIVATE_MESSAGE      9       /* Private message */
+    #define SILC_PACKET_PRIVATE_MESSAGE_KEY  10      /* Private message key*/
+    #define SILC_PACKET_COMMAND              11      /* Command */
+    #define SILC_PACKET_COMMAND_REPLY        12      /* Reply to a command */
+    #define SILC_PACKET_KEY_EXCHANGE         13      /* Start of KE */
+    #define SILC_PACKET_KEY_EXCHANGE_1       14      /* KE1 */
+    #define SILC_PACKET_KEY_EXCHANGE_2       15      /* KE2 */
+    #define SILC_PACKET_CONNECTION_AUTH_REQUEST 16   /* Request of auth meth */
+    #define SILC_PACKET_CONNECTION_AUTH      17      /* Connectinon auth */
+    #define SILC_PACKET_NEW_ID               18      /* Sending new ID */
+    #define SILC_PACKET_NEW_CLIENT           19      /* Client registering */
+    #define SILC_PACKET_NEW_SERVER           20      /* Server registering */
+    #define SILC_PACKET_NEW_CHANNEL          21      /* Channel registering */
+    #define SILC_PACKET_REKEY                22      /* Re-key start */
+    #define SILC_PACKET_REKEY_DONE           23      /* Re-key done */
+    #define SILC_PACKET_HEARTBEAT            24      /* Heartbeat */
+    #define SILC_PACKET_KEY_AGREEMENT        25      /* Key Agreement request */
+    #define SILC_PACKET_RESUME_ROUTER        26      /* Backup router resume */
+    #define SILC_PACKET_FTP                  27      /* File Transfer */
+    #define SILC_PACKET_RESUME_CLIENT        28      /* Client resume */
+    #define SILC_PACKET_ACK                  29      /* Acknowledgement */
+    
+    #define SILC_PACKET_PRIVATE              200     /* Private range start  */
+    #define SILC_PACKET_MAX                  255     /* RESERVED */
+    
+    #define SILC_PACKET_NONE                 0       /* RESERVED */
+    #define SILC_PACKET_ANY                  0
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-SilcPacketWrapCoder.html b/docs/toolkit/manual/silcpacket-SilcPacketWrapCoder.html new file mode 100644 index 0000000..132e0c4 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-SilcPacketWrapCoder.html @@ -0,0 +1,281 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcPacketWrapCoder

    + + +SYNOPSIS + +
    
+    typedef SilcBool (*SilcPacketWrapCoder)(SilcStream stream,
+                                            SilcStreamStatus status,
+                                            SilcBuffer buffer,
+                                            void *context);
+
+
    +DESCRIPTION + +
    
+    The encoder/decoder callback for silc_packet_stream_wrap.
+
+    If the `status' is SILC_STREAM_CAN_WRITE then additional data can
+    be added to `buffer' which contains the data that is being written
+    to the stream.  There is at least 16 bytes of free space in head
+    space of the buffer in case new headers need to be added. 
+    The silc_buffer_enlarge should be called to verify that there is
+    enough room before adding data to it.  The `buffer' must not be freed.
+    If the return value is FALSE the encoding failed and the packet is
+    not sent at all and the stream will receive error.  Return TRUE if
+    the encoding succeeded.
+
+    If the `status' is SILC_STREAM_CAN_READ then data from the `buffer'
+    may be read before it is passed to reader when silc_stream_read is
+    called.  The `buffer' may be advanced also to hide data in it.  If
+    return value is FALSE the decoding failed (or the packet is ignored)
+    and the packet will not be processed by the wrapped packet stream.
+    If there are other packet streams wanting the same packet, they will
+    get it, and if not the packet will drop.  Return TRUE if decoding
+    succeeded.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_engine_free_streams_list.html b/docs/toolkit/manual/silcpacket-silc_packet_engine_free_streams_list.html new file mode 100644 index 0000000..0888b4d --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_engine_free_streams_list.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_engine_free_streams_list

    + + +SYNOPSIS + +
    
+    void silc_packet_engine_free_streams_list(SilcDList streams);
+
+
    +DESCRIPTION + +
    
+    Free's the streams list returned by silc_packet_engine_get_streams.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_engine_get_streams.html b/docs/toolkit/manual/silcpacket-silc_packet_engine_get_streams.html new file mode 100644 index 0000000..fc7936f --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_engine_get_streams.html @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_engine_get_streams

    + + +SYNOPSIS + +
    
+    SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine);
+
+
    +DESCRIPTION + +
    
+    Returns list of packet streams added to the packet engine.  The caller
+    must free the list with silc_packet_engine_free_streams_list.
+
+
    +NOTES + +
    
+    This function may also return disconnected and destroyed streams.  The
+    caller should use silc_packet_stream_is_valid to check if the stream
+    is valid.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_engine_start.html b/docs/toolkit/manual/silcpacket-silc_packet_engine_start.html new file mode 100644 index 0000000..9eac469 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_engine_start.html @@ -0,0 +1,274 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_engine_start

    + + +SYNOPSIS + +
    
+    SilcPacketEngine
+    silc_packet_engine_start(SilcRng rng, SilcBool router,
+                             SilcPacketCallbacks *callbacks,
+                             void *callback_context);
+
+
    +DESCRIPTION + +
    
+    Create new packet engine for processing incoming and outgoing packets.
+    If `router' is  TRUE then the application is considered to be router
+    server, and certain packets are handled differently.  Client and normal
+    server must set it to FALSE.  The `callbacks' is a SilcPacketCallbacks
+    structure provided by the caller which includes the callbacks that is
+    called when for example packet is received, or end of stream is called.
+
+
    +NOTES + +
    
+    The packet engine is thread safe.  You can use one packet engine in
+    multi threaded application.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_engine_stop.html b/docs/toolkit/manual/silcpacket-silc_packet_engine_stop.html new file mode 100644 index 0000000..5299dc2 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_engine_stop.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_engine_stop

    + + +SYNOPSIS + +
    
+    void silc_packet_engine_stop(SilcPacketEngine engine);
+
+
    +DESCRIPTION + +
    
+    Stop the packet engine.  No new packets can be sent or received after
+    calling this, and the `engine' will become invalid.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_error_string.html b/docs/toolkit/manual/silcpacket-silc_packet_error_string.html new file mode 100644 index 0000000..b9a4f44 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_error_string.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_error_string

    + + +SYNOPSIS + +
    
+    const char *silc_packet_error_string(SilcPacketError error);
+
+
    +DESCRIPTION + +
    
+    Return the packet error as string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_free.html b/docs/toolkit/manual/silcpacket-silc_packet_free.html new file mode 100644 index 0000000..f88e208 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_free.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_free

    + + +SYNOPSIS + +
    
+    void silc_packet_free(SilcPacket packet);
+
+
    +DESCRIPTION + +
    
+    This function is used to free the SilcPacket pointer that application
+    receives in the SilcPacketReceive callback.  Application must free
+    the packet if it takes it in to processing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_get_context.html b/docs/toolkit/manual/silcpacket-silc_packet_get_context.html new file mode 100644 index 0000000..7a58b6c --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_get_context.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_get_context

    + + +SYNOPSIS + +
    
+    void *silc_packet_get_context(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Returns the current set application context, or NULL if none is set.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_get_engine.html b/docs/toolkit/manual/silcpacket-silc_packet_get_engine.html new file mode 100644 index 0000000..d0f9462 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_get_engine.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_get_engine

    + + +SYNOPSIS + +
    
+    SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Returns the packet engine from the `stream'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_get_ids.html b/docs/toolkit/manual/silcpacket-silc_packet_get_ids.html new file mode 100644 index 0000000..03a0445 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_get_ids.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_get_ids

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_get_ids(SilcPacketStream stream,
+                                 SilcBool *src_id_set, SilcID *src_id,
+                                 SilcBool *dst_id_set, SilcID *dst_id);
+
+
    +DESCRIPTION + +
    
+    Returns source and destination IDs from the packet stream.  The
+    `src_id_set' is set to TRUE if the source ID was returned.  The
+    `dst_id_set' is set to TRUE if the destination ID was returned.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_get_keys.html b/docs/toolkit/manual/silcpacket-silc_packet_get_keys.html new file mode 100644 index 0000000..7e21c26 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_get_keys.html @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_get_keys

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_get_keys(SilcPacketStream stream,
+                                  SilcCipher *send_key,
+                                  SilcCipher *receive_key,
+                                  SilcHmac *send_hmac,
+                                  SilcHmac *receive_hmac);
+
+
    +DESCRIPTION + +
    
+    Returns the pointers of current ciphers and HMACs from the `stream'.
+    Returns FALSE if keys are not set.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_get_sender.html b/docs/toolkit/manual/silcpacket-silc_packet_get_sender.html new file mode 100644 index 0000000..d56dfb3 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_get_sender.html @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_get_sender

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_get_sender(SilcPacket packet,
+                                    const char **sender_ip,
+                                    SilcUInt16 *sender_port);
+
+
    +DESCRIPTION + +
    
+    Returns the packet sender's IP address and port from UDP packet
+    indicated by `packet'.  This can be called only from the packet
+    callback to retrieve the information of the packet's sender.  Returns
+    FALSE if the information is not available.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_send.html b/docs/toolkit/manual/silcpacket-silc_packet_send.html new file mode 100644 index 0000000..8410658 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_send.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_send

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_send(SilcPacketStream stream,
+                              SilcPacketType type, SilcPacketFlags flags,
+                              const unsigned char *data,
+                              SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Send `data' of length of `data_len' to the packet stream indicated by
+    `stream'.  If ciphers and HMACs were set using silc_packet_set_keys
+    the packet will be encrypted and MAC will be computed for it.  If
+    silc_packet_set_ids was used to set source and destination ID for the
+    packet stream those IDs are used in the packet.  If IDs have not been
+    set and they need to be provided then silc_packet_send_ext function
+    should be used.  Otherwise, the packet will not have IDs set at all.
+    Returns FALSE if packet could not be sent.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_send_ext.html b/docs/toolkit/manual/silcpacket-silc_packet_send_ext.html new file mode 100644 index 0000000..4e7f9c2 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_send_ext.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_send_ext

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_packet_send_ext(SilcPacketStream stream,
+                         SilcPacketType type, SilcPacketFlags flags,
+                         SilcIdType src_id_type, void *srd_id,
+                         SilcIdType dst_id_type, void *dst_id,
+                         const unsigned char *data, SilcUInt32 data_len,
+                         SilcCipher cipher, SilcHmac hmac);
+
+
    +DESCRIPTION + +
    
+    Same as silc_packet_send but with this function different sending
+    parameters can be sent as argument.  This function can be used to
+    set specific IDs, cipher and HMAC to be used in packet sending,
+    instead of the ones saved in the `stream'.  If any of the extra
+    pointers are NULL, default values set to the stream will apply.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_send_va.html b/docs/toolkit/manual/silcpacket-silc_packet_send_va.html new file mode 100644 index 0000000..535b5ae --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_send_va.html @@ -0,0 +1,276 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_send_va

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_send_va(SilcPacketStream stream,
+                                 SilcPacketType type,
+                                 SilcPacketFlags flags, ...);
+
+
    +DESCRIPTION + +
    
+    Same as silc_packet_send but takes the data in as variable argument
+    formatted buffer (see silcbuffmt.h).  The arguments must be ended
+    with SILC_STR_END.  Returns FALSE if packet could not be sent or
+    the buffer could not be formatted.
+
+
    +EXAMPLE + +
    
+    // Send NEW_CLIENT packet
+    silc_packet_send_va(stream, SILC_PACKET_NEW_CLIENT, 0,
+                        SILC_STR_UI_SHORT(username_len),
+                        SILC_STR_DATA(username, username_len),
+                        SILC_STR_UI_SHORT(realname_len),
+                        SILC_STR_DATA(realname, realname_len),
+                        SILC_STR_END);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_send_va_ext.html b/docs/toolkit/manual/silcpacket-silc_packet_send_va_ext.html new file mode 100644 index 0000000..3ab9254 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_send_va_ext.html @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_send_va_ext

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_packet_send_va_ext(SilcPacketStream stream,
+                            SilcPacketType type, SilcPacketFlags flags,
+                            SilcIdType src_id_type, void *srd_id,
+                            SilcIdType dst_id_type, void *dst_id,
+                            SilcCipher cipher, SilcHmac hmac, ...);
+
+
    +DESCRIPTION + +
    
+    Same as silc_packet_send_va but with this function different sending
+    parameters can be sent as argument.  This function can be used to
+    set specific IDs, cipher and HMAC to be used in packet sending,
+    instead of the ones saved in the `stream'.  If any of the extra
+    pointers are NULL, default values set to the stream will apply.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_set_context.html b/docs/toolkit/manual/silcpacket-silc_packet_set_context.html new file mode 100644 index 0000000..69cc5f0 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_set_context.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_set_context

    + + +SYNOPSIS + +
    
+    void silc_packet_set_context(SilcPacketStream stream,
+                                 void *stream_context);
+
+
    +DESCRIPTION + +
    
+    Sets a stream specific context to the stream.  The context will
+    be delivered to all callback functions, and it can be retrieved by
+    calling silc_packet_get_context function as well.  Note that this is
+    separate packet stream specific context, and not the same as
+    `callback_context' in silc_packet_engine_start.  Both will be delivered
+    to the callbacks, and this context as the `stream_context' argument.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_set_ids.html b/docs/toolkit/manual/silcpacket-silc_packet_set_ids.html new file mode 100644 index 0000000..53aa383 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_set_ids.html @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_set_ids

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_set_ids(SilcPacketStream stream,
+                                 SilcIdType src_id_type, const void *src_id
+                                 SilcIdType dst_id_type, const void *dst_id);
+
+
    +DESCRIPTION + +
    
+    Set the source ID and destination ID to be used when sending packets to
+    this packet stream.  The IDs to be used for a packet stream can be
+    overridden when sending packets.  However, if the IDs do not ever change
+    for the packet stream it is recommended they are set using this function.
+    In this case they can be omitted when sending packets to the stream.
+    It is also possible to set only source or destination ID.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_set_keys.html b/docs/toolkit/manual/silcpacket-silc_packet_set_keys.html new file mode 100644 index 0000000..da73d0f --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_set_keys.html @@ -0,0 +1,270 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_set_keys

    + + +SYNOPSIS + +
    
+    void silc_packet_set_keys(SilcPacketStream stream, SilcCipher send_key,
+                              SilcCipher receive_key, SilcHmac send_hmac,
+                              SilcHmac receive_hmac, SilcBool rekey);
+
+
    +DESCRIPTION + +
    
+    Set ciphers and HMACs to be used to encrypt sent packets, and decrypt
+    received packets.  This can be called multiple times to change the
+    ciphers and HMACs.
+
+    If the `rekey' is TRUE this function will send SILC_PACKET_REKEY_DONE
+    to the `stream' and will set the new keys.  If it is FALSE the keys
+    are changed but the packet is not changed.
+
+    When changing keys the old cipher and HMACs will be freed.  If the keys
+    are not set at all, packets will not be encrypted or decrypted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_set_sid.html b/docs/toolkit/manual/silcpacket-silc_packet_set_sid.html new file mode 100644 index 0000000..98e2eb3 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_set_sid.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_set_sid

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
+
+
    +DESCRIPTION + +
    
+    Sets new Security ID to the packet stream indicated by `stream'.  This
+    is called only if the IV Included property was set to the stream
+    by calling silc_packet_stream_set_iv_included.  This function sets
+    new Security ID to the stream which is then included in the ciphertext
+    of a packet.  The `sid' must be 0 when it is set for the very first
+    time and must be increased by one after each rekey.  This function must
+    be called every time new keys are added to the stream after a rekey.
+
+    If this function is called when the IV Included property has not been
+    set to the stream the `sid' will be ignored.  Returns FALSE if the
+    IV Included has not been set, TRUE otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_add_remote.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_add_remote.html new file mode 100644 index 0000000..ce31d3b --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_add_remote.html @@ -0,0 +1,297 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_add_remote

    + + +SYNOPSIS + +
    
+    SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
+                                                   const char *remote_ip,
+                                                   SilcUInt16 remote_port,
+                                                   SilcPacket packet);
+
+
    +DESCRIPTION + +
    
+    This function is used to add remote receivers in packet stream `stream'
+    that has UDP/IP socket stream as the underlaying stream.  This function
+    cannot be used with other type of streams.  This returns new packet
+    stream context that can be used to send to and receive packets from
+    the specified remote IP and remote port, or NULL on error.  The `stream'
+    is the actual stream that is used to send and receive the data.
+
+    When the parent `stream' receives packets from remote IP address
+    and port that does not have its own remote packet stream, it returns
+    the packet to the packet callback set for `stream'.  The sender's
+    IP address and port can then be retrieved by using the
+    silc_packet_get_sender function and to create new packet stream by
+    calling this function.  After that, all packets from that IP address
+    and port will be received by the new packet stream.
+
+    If the `packet' is non-NULL it will be injected into the new packet
+    stream as soon as the scheduler associated with `stream' schedules
+    new tasks.  It can be used to inject an incoming packet to the stream.
+
+    This interface is for connectionless UDP streams.  If it is possible
+    to create connected stream it should be done for performance reasons.
+
+
    +EXAMPLE + +
    
+    // Create parent packet stream, it can receive packets from anywhere
+    listener = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
+    parent = silc_packet_stream_create(engine, schedule, listener);
+
+    ...
+    // Received a packet to the parent stream, get the sender information.
+    silc_packet_get_sender(packet, &ip, &port);
+
+    // Create new packet stream for this remote location.
+    remote = silc_packet_stream_add_remote(parent, ip, port, packet);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_create.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_create.html new file mode 100644 index 0000000..fe0354c --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_create.html @@ -0,0 +1,281 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_create

    + + +SYNOPSIS + +
    
+    SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
+                                               SilcSchedule schedule,
+                                               SilcStream stream);
+
+
    +DESCRIPTION + +
    
+    Create new packet stream and use the `stream' as underlaying stream.
+    Usually the `stream' would be a socket stream, but it can be any
+    stream.  After this function returns, packets can immediately be
+    sent to and received from the stream.
+
+    The `stream' will be owned by the packet stream and will be closed
+    and destroyed when the packet stream is destroyed.  If the packet
+    stream creation fails the `stream' is left intact.
+
+
    +NOTES + +
    
+    SilcPacketStream cannot be used with silc_stream_* routines (such as
+    silc_stream_read and silc_stream_write) because of its special nature.
+    Use the silc_packet_send and the silc_packet_send_ext to send packets.
+    To read packets you will receive the packet receive callback from
+    packet engine.  Destroy the stream with silc_packet_stream_destroy.
+
+    The SilcPacketStream is thread safe.  Same context can be safely used
+    in multi threaded environment.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_destroy.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_destroy.html new file mode 100644 index 0000000..a77cec6 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_destroy.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_destroy

    + + +SYNOPSIS + +
    
+    void silc_packet_stream_destroy(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Destroy packet stream and the underlaying stream.  This will also
+    close and destroy the underlaying stream.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_get_stream.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_get_stream.html new file mode 100644 index 0000000..6978954 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_get_stream.html @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_get_stream

    + + +SYNOPSIS + +
    
+    SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Returns the actual stream that is associated with the packet stream
+    `stream'.  The caller must not free the returned stream.  The returned
+    stream is the same pointer that was set for silc_packet_stream_create.
+    This function could be used for example when an error callback is
+    called by the packet engine to retrieve the actual lower level error
+    from the stream.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_inject.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_inject.html new file mode 100644 index 0000000..2052f9a --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_inject.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_inject

    + + +SYNOPSIS + +
    
+ SilcBool silc_packet_stream_inject(SilcPacketStream stream,
+                                    SilcPacket packet);
+
+
    +DESCRIPTION + +
    
+    This function can be used to inject the `packet' to the given
+    packet `stream'.  The packet will appear in the packet stream's
+    packet handler(s).  If this returns FALSE the packet was not
+    injected.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_is_udp.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_is_udp.html new file mode 100644 index 0000000..08716e5 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_is_udp.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_is_udp

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_stream_is_udp(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the packet stream indicated by `stream' is using
+    UDP transport.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_is_valid.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_is_valid.html new file mode 100644 index 0000000..d7fb17f --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_is_valid.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_is_valid

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_stream_is_valid(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the packet stream indicated by `stream' is valid and
+    has not been disconnected or destroyed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_link.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_link.html new file mode 100644 index 0000000..913735e --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_link.html @@ -0,0 +1,290 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_link

    + + +SYNOPSIS + +
    
+    SilcBool silc_packet_stream_link(SilcPacketStream stream,
+                                     SilcPacketCallbacks *callbacks,
+                                     void *callback_context,
+                                     int priority, ...);
+
+
    +DESCRIPTION + +
    
+    Links the packet processing callbacks indicated by `callbacks' into
+    the packet stream indicated by `stream' with priority `priority' for
+    the packet types given in the variable argument list.  This function
+    can be used to link to the packet stream for specific packet types
+    and receive them in the specified callbacks.  This way, a third party,
+    for example some library may attach itself into the packet stream
+    and receive and process certain packets.  The variable argument
+    list is ended with -1.  To link to receive all packets use
+    SILC_PACKET_ANY.
+
+    The default packet processing callbacks given as argument to the
+    silc_packet_engine_start has the priority 0.  Any priority higher
+    than 0 will then take precedence over the default callbacks.  Any
+    priority lower than 0 (negative value) will be processed after the
+    default callbacks.
+
+    Note that setting only the 'packet_receive' callback in the `callbacks'
+    is required.
+
+
    +EXAMPLE + +
    
+    // Link to this packet stream, with high priority, for
+    // SILC_PACKET_CONNECTION_AUTH and SILC_PACKET_CONNECTION_AUTH_REQUEST
+    // packets. We don't care about other packets.
+    silc_packet_stream_link(stream, our_callbacks, our_context,
+                            1000000, SILC_PACKET_CONNECTION_AUTH,
+                            SILC_PACKET_CONNECTION_AUTH_REQUEST, -1);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_ref.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_ref.html new file mode 100644 index 0000000..56790e3 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_ref.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_ref

    + + +SYNOPSIS + +
    
+    void silc_packet_stream_ref(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Increase reference counter for the stream indicated by `stream'.  This
+    can be used to take a reference for the stream.  To unreference the
+    stream call silc_packet_stream_unref function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_set_iv_included.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_set_iv_included.html new file mode 100644 index 0000000..2686f78 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_set_iv_included.html @@ -0,0 +1,268 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_set_iv_included

    + + +SYNOPSIS + +
    
+    void silc_packet_stream_set_iv_included(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Sets an IV Included property for the stream indicated by `stream'.
+    This means that the IV used in the encryption will be included in
+    the resulted ciphertext.  This makes it possible to send and receive
+    packets on unreliable network transport protocol, such as UDP/IP.
+    This must be called if the underlaying stream in the `stream' is UDP
+    stream.
+
+    When this is set to the stream the silc_packet_set_sid must be called
+    to set new Security ID.  The Security ID will be included with the IV
+    in the ciphertext.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_set_router.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_set_router.html new file mode 100644 index 0000000..33c4b9b --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_set_router.html @@ -0,0 +1,262 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_set_router

    + + +SYNOPSIS + +
    
+    void silc_packet_stream_set_router(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    When called sets the stream indicates by `stream' as SILC router
+    connection stream.  This causes that certain packets are handled
+    differently.  This must be called for router connection streams and
+    must not be called for any other stream.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_set_stream.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_set_stream.html new file mode 100644 index 0000000..bc3c2d6 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_set_stream.html @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_set_stream

    + + +SYNOPSIS + +
    
+    void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
+                                       SilcStream stream);
+
+
    +DESCRIPTION + +
    
+    This function may be used to change the underlaying stream in the
+    packet stream indicated by `packet_stream'.  Note that the old
+    stream will not be used after calling this function.  The caller is
+    responsible destroying the old stream.  The `stream' will use
+    the same scheduler as the `packet_stream'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_unlink.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_unlink.html new file mode 100644 index 0000000..8ffd41c --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_unlink.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_unlink

    + + +SYNOPSIS + +
    
+    void silc_packet_stream_unlink(SilcPacketStream stream,
+                                   SilcPacketCallbacks *callbacks,
+                                   void *callback_context);
+
+
    +DESCRIPTION + +
    
+    Unlinks the `callbacks' with `callback_context' from the packet stream
+    indicated by `stream'.  This function must be called for the callbacks
+    that was linked to `stream' when they are not needed anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_unref.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_unref.html new file mode 100644 index 0000000..9cb7e8d --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_unref.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_unref

    + + +SYNOPSIS + +
    
+    void silc_packet_stream_unref(SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Decrease reference counter for the stream indicated by `stream'.  If
+    the counter hits zero the stream will be destroyed automatically.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_stream_wrap.html b/docs/toolkit/manual/silcpacket-silc_packet_stream_wrap.html new file mode 100644 index 0000000..5599bd6 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_stream_wrap.html @@ -0,0 +1,299 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_stream_wrap

    + + +SYNOPSIS + +
    
+    SilcStream silc_packet_stream_wrap(SilcPacketStream stream,
+                                       SilcPacketType type,
+                                       SilcPacketFlags flags,
+                                       SilcBool blocking_mode,
+                                       SilcIdType src_id_type, void *src_id,
+                                       SilcIdType dst_id_type, void *dst_id,
+                                       SilcPacketWrapCoder coder,
+                                       void *context);
+
+
    +DESCRIPTION + +
    
+    Wraps the packet stream indicated by `stream' into a SilcStream for
+    the packet type indicated by `type' with packet flags indicated by
+    `flags'.  The returned SilcStream can be used to read and write the
+    specified SILC packets with the specified packet flags, by calling
+    silc_stream_read and silc_stream_write, respectively.  The returned
+    stream can be destroyed by calling silc_stream_destroy.  It does not
+    destroy the wrapped packet stream.
+
+    If the `blocking_mode' mode is TRUE then the silc_stream_read and
+    silc_stream_write may block the calling process or thread until SILC
+    packet is read or written.  If it is FALSE the stream is in non-blocking
+    mode and the calls never block.  The returned stream is thread-safe and
+    packets may be read and written in multi-threaded environment.
+
+    In non-blocking mode the silc_stream_set_notifier must be called before
+    the returned stream can be used to read packets.  The stream status
+    SILC_STREAM_CAN_READ will be returned to the notifier callback to
+    indicate that a packet is ready for reading.  Calling silc_stream_read
+    once returns one complete SILC packet data payload (which is of type of
+    `type').
+
+    If src_id and/or dst_id are set they will be used as the ids in the
+    sent SILC packets.  If the dst_id is set then the stream will receive
+    packets only originating from that id.
+
+    The `coder' is optional encoder/decoder callback which the packet engine
+    will call if it is non-NULL.  It can be used to encode additional data
+    into each packet when silc_stream_write is called or decode data before
+    it is passed to reader when silc_stream_read is called.  The `context'
+    is passed to `coder'.
+
+    The returned SilcStream can be used as any normal stream and all
+    SilcStream API functions may be used with the stream.  This returns
+    NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_wait.html b/docs/toolkit/manual/silcpacket-silc_packet_wait.html new file mode 100644 index 0000000..265c130 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_wait.html @@ -0,0 +1,299 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_wait

    + + +SYNOPSIS + +
    
+    int silc_packet_wait(void *waiter, int timeout,
+                         SilcPacket *return_packet)
+
+
    +DESCRIPTION + +
    
+    A special function that can be used to wait for a packet to arrive.
+    This function will block the calling process or thread until either
+    a packet is received into the `return_packet' pointer or the specified
+    timeout value `timeout', which is in milliseconds, will expire.  If
+    the timeout is 0, no timeout exist.  Before calling this function the
+    silc_packet_wait_init must be called.  The caller is responsible for
+    freeing the returned packet with silc_packet_free.
+
+    This function can be used for example from a thread that wants to
+    block until SILC packet has been received.
+
+    Returns 1 when packet was received, 0 if timeout occurred and -1 if
+    error occurred.
+
+
    +EXAMPLE + +
    
+    static int foo_read_data(FooContext c)
+    {
+      SilcPacket packet;
+      void *waiter;
+      ...
+
+      // Will wait for private message packets
+      if (c->initialized == FALSE) {
+        waiter = silc_packet_wait_init(stream,
+                                       SILC_PACKET_PRIVATE_MESSAGE, -1);
+        c->initialized = TRUE;
+      }
+
+      ...
+      // Wait here until private message packet is received
+      if ((silc_packet_wait(waiter, 0, &packet)) < 0)
+        return -1;
+
+      ... process packet ...
+
+      return 1;
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_wait_init.html b/docs/toolkit/manual/silcpacket-silc_packet_wait_init.html new file mode 100644 index 0000000..8788b3a --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_wait_init.html @@ -0,0 +1,291 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_wait_init

    + + +SYNOPSIS + +
    
+    void *silc_packet_wait_init(SilcPacketStream stream,
+                                const SilcID *source_id, ...);
+
+
    +DESCRIPTION + +
    
+    Initializes a packet waiter for the packet stream `stream' and
+    for the variable argument list of packet types.  The function
+    silc_packet_wait can be used to block the thread until a packet
+    has been received.
+
+    This function is used to initialize the waiting and to give the list
+    of packet types that caller wish to receive.  The variable argument
+    list must end with -1.  To receive all packets use SILC_PACKET_ANY.
+    If the `source_id' is non-NULL then only packets of the specified
+    type from the specified `source_id' are received.  If it is NULL
+    then the packet source is ignored.
+
+    Returns a context that must be given to the silc_packet_wait function
+    as argument.  Returns NULL on error.  To uninitialize the waiting
+    call silc_packet_wait_uninit.
+
+
    +NOTES + +
    
+    Note that packets may be available immediately after calling this
+    function and they will be buffered, until silc_packet_wait is called.
+
+
    +EXAMPLE + +
    
+    void *waiter;
+
+    // Will wait for private message packets
+    waiter = silc_packet_wait_init(stream, NULL,
+                                   SILC_PACKET_PRIVATE_MESSAGE, -1);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket-silc_packet_wait_uninit.html b/docs/toolkit/manual/silcpacket-silc_packet_wait_uninit.html new file mode 100644 index 0000000..1a1dab5 --- /dev/null +++ b/docs/toolkit/manual/silcpacket-silc_packet_wait_uninit.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_packet_wait_uninit

    + + +SYNOPSIS + +
    
+    void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
+
+
    +DESCRIPTION + +
    
+    Uninitializes the waiting context.  This may be called also from
+    another thread while other thread is waiting for packets.  This will
+    inform the waiting thread to stop waiting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Packet Engine Interface
    +SilcPacketType
    +SilcPacketFlags
    +SilcPacketEngine
    +SilcPacketStream
    +SilcPacket
    +SilcPacketError
    +SilcPacketReceiveCb
    +SilcPacketEosCb
    +SilcPacketErrorCb
    +SilcPacketCallbacks
    +silc_packet_engine_start
    +silc_packet_engine_stop
    +silc_packet_error_string
    +silc_packet_engine_get_streams
    +silc_packet_engine_free_streams_list
    +silc_packet_stream_create
    +silc_packet_stream_add_remote
    +silc_packet_stream_inject
    +silc_packet_stream_destroy
    +silc_packet_stream_is_valid
    +silc_packet_stream_set_router
    +silc_packet_stream_set_iv_included
    +silc_packet_stream_set_stream
    +silc_packet_stream_get_stream
    +silc_packet_stream_link
    +silc_packet_stream_unlink
    +SilcPacketWrapCoder
    +silc_packet_stream_wrap
    +silc_packet_stream_is_udp
    +silc_packet_get_sender
    +silc_packet_stream_ref
    +silc_packet_stream_unref
    +silc_packet_get_engine
    +silc_packet_set_context
    +silc_packet_get_context
    +silc_packet_set_keys
    +silc_packet_get_keys
    +silc_packet_set_ids
    +silc_packet_get_ids
    +silc_packet_set_sid
    +silc_packet_send
    +silc_packet_send_ext
    +silc_packet_send_va
    +silc_packet_send_va_ext
    +silc_packet_wait_init
    +silc_packet_wait_uninit
    +silc_packet_wait
    +silc_packet_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket.html b/docs/toolkit/manual/silcpacket.html new file mode 100644 index 0000000..b2db43d --- /dev/null +++ b/docs/toolkit/manual/silcpacket.html @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcpacket.html + + + + +
    + +SILC Packet Engine Interface
    Header: silcpacket.h

    + + +DESCRIPTION + +
    
+ The SILC secure binary packet protocol interface, provides interface for
+ sending and receiving SILC packets.  The interface provides a packet
+ engine, that can be used to receive packets from packet streams, and
+ routines for sending all kinds of SILC packets.
+
+ The packet engine and packet stream are thread safe.  They can be safely
+ used in multi threaded environment.
+
+
  • SilcPacketType +
  • SilcPacketFlags +
  • SilcPacketEngine +
  • SilcPacketStream +
  • SilcPacket +
  • SilcPacketError +
  • SilcPacketReceiveCb +
  • SilcPacketEosCb +
  • SilcPacketErrorCb +
  • SilcPacketCallbacks +
  • silc_packet_engine_start +
  • silc_packet_engine_stop +
  • silc_packet_error_string +
  • silc_packet_engine_get_streams +
  • silc_packet_engine_free_streams_list +
  • silc_packet_stream_create +
  • silc_packet_stream_add_remote +
  • silc_packet_stream_inject +
  • silc_packet_stream_destroy +
  • silc_packet_stream_is_valid +
  • silc_packet_stream_set_router +
  • silc_packet_stream_set_iv_included +
  • silc_packet_stream_set_stream +
  • silc_packet_stream_get_stream +
  • silc_packet_stream_link +
  • silc_packet_stream_unlink +
  • SilcPacketWrapCoder +
  • silc_packet_stream_wrap +
  • silc_packet_stream_is_udp +
  • silc_packet_get_sender +
  • silc_packet_stream_ref +
  • silc_packet_stream_unref +
  • silc_packet_get_engine +
  • silc_packet_set_context +
  • silc_packet_get_context +
  • silc_packet_set_keys +
  • silc_packet_get_keys +
  • silc_packet_set_ids +
  • silc_packet_get_ids +
  • silc_packet_set_sid +
  • silc_packet_send +
  • silc_packet_send_ext +
  • silc_packet_send_va +
  • silc_packet_send_va_ext +
  • silc_packet_wait_init +
  • silc_packet_wait_uninit +
  • silc_packet_wait +
  • silc_packet_free + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpacket.xref b/docs/toolkit/manual/silcpacket.xref new file mode 100644 index 0000000..396671e --- /dev/null +++ b/docs/toolkit/manual/silcpacket.xref @@ -0,0 +1,55 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcpacket.h" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 0 + "SILC Packet Engine Interface" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 1 + "SilcPacketType" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 8 + "SilcPacketFlags" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 8 + "SilcPacketEngine" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 5 + "SilcPacketStream" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 5 + "SilcPacket" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 5 + "SilcPacketError" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 8 + "SilcPacketReceiveCb" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "SilcPacketEosCb" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "SilcPacketErrorCb" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "SilcPacketCallbacks" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 5 + "silc_packet_engine_start" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_engine_stop" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_error_string" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_engine_get_streams" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_engine_free_streams_list" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_create" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_add_remote" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_inject" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_destroy" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_is_valid" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_set_router" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_set_iv_included" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_set_stream" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_get_stream" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_link" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_unlink" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "SilcPacketWrapCoder" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_wrap" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_is_udp" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_get_sender" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_ref" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_stream_unref" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_get_engine" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_set_context" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_get_context" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_set_keys" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_get_keys" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_set_ids" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_get_ids" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_set_sid" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_send" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_send_ext" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_send_va" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_send_va_ext" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_wait_init" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_wait_uninit" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_wait" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + "silc_packet_free" "/home/priikone/silc1/doc/toolkit/silcpacket.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcpk-SilcPublicKeyIdentifier.html b/docs/toolkit/manual/silcpk-SilcPublicKeyIdentifier.html new file mode 100644 index 0000000..b4f7c65 --- /dev/null +++ b/docs/toolkit/manual/silcpk-SilcPublicKeyIdentifier.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPublicKeyIdentifier

    + + +NAME + +
    
+    typedef struct { ... } *SilcPublicKeyIdentifier,
+                            SilcPublicKeyIdentifierStruct;
+
+
    +DESCRIPTION + +
    
+    This structure contains the SILC Public Key identifier.  Note that
+    some of the fields may be NULL.
+
+
    +SOURCE + +
        typedef struct SilcPublicKeyIdentifierObject {
+      char *username;
+      char *host;
+      char *realname;
+      char *email;
+      char *org;
+      char *country;
+      char *version;
+    } *SilcPublicKeyIdentifier, SilcPublicKeyIdentifierStruct;
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Interface
    +SilcPublicKeyIdentifier
    +SilcSILCPublicKey
    +SilcSILCPrivateKey
    +silc_pkcs_silc_generate_key
    +silc_pkcs_silc_encode_identifier
    +silc_pkcs_silc_decode_identifier
    +silc_pkcs_silc_public_key_version
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk-SilcSILCPrivateKey.html b/docs/toolkit/manual/silcpk-SilcSILCPrivateKey.html new file mode 100644 index 0000000..2f79767 --- /dev/null +++ b/docs/toolkit/manual/silcpk-SilcSILCPrivateKey.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSILCPrivateKey

    + + +NAME + +
    
+    typedef struct { ... } *SilcSILCPrivateKey;
+
+
    +DESCRIPTION + +
    
+    This structure defines the SILC protocol implementation specific
+    private key.  This structure isn't usually needed by the user.
+
+
    +SOURCE + +
        typedef struct SilcSILCPrivateKeyStruct {
+      const SilcPKCSAlgorithm *pkcs;   /* PKCS algorithm */
+      void *private_key;               /* PKCS algorithm specific private key */
+    } *SilcSILCPrivateKey;
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Interface
    +SilcPublicKeyIdentifier
    +SilcSILCPublicKey
    +SilcSILCPrivateKey
    +silc_pkcs_silc_generate_key
    +silc_pkcs_silc_encode_identifier
    +silc_pkcs_silc_decode_identifier
    +silc_pkcs_silc_public_key_version
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk-SilcSILCPublicKey.html b/docs/toolkit/manual/silcpk-SilcSILCPublicKey.html new file mode 100644 index 0000000..1b7f6ae --- /dev/null +++ b/docs/toolkit/manual/silcpk-SilcSILCPublicKey.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSILCPublicKey

    + + +NAME + +
    
+    typedef struct { ... } *SilcSILCPublicKey;
+
+
    +DESCRIPTION + +
    
+    This structure defines the SILC protocol style public key.  User
+    doesn't have to access this structure usually, except when access to
+    the identifier is required.  The silc_pkcs_get_context for the
+    PKCS type SILC_PKCS_SILC returns this context.
+
+
    +SOURCE + +
        typedef struct SilcSILCPublicKeyStruct {
+      SilcPublicKeyIdentifierStruct identifier;
+      const SilcPKCSAlgorithm *pkcs;   /* PKCS algorithm */
+      void *public_key;                /* PKCS algorithm specific public key */
+    } *SilcSILCPublicKey;
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Interface
    +SilcPublicKeyIdentifier
    +SilcSILCPublicKey
    +SilcSILCPrivateKey
    +silc_pkcs_silc_generate_key
    +silc_pkcs_silc_encode_identifier
    +silc_pkcs_silc_decode_identifier
    +silc_pkcs_silc_public_key_version
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk-silc_pkcs_silc_decode_identifier.html b/docs/toolkit/manual/silcpk-silc_pkcs_silc_decode_identifier.html new file mode 100644 index 0000000..b08e63a --- /dev/null +++ b/docs/toolkit/manual/silcpk-silc_pkcs_silc_decode_identifier.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_silc_decode_identifier

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_silc_decode_identifier(const char *identifier,
+                                              SilcPublicKeyIdentifier ident);
+
+
    +DESCRIPTION + +
    
+    Decodes SILC protocol public key identifier `identifier' into the
+    the `ident' structure.  Returns FALSE if the identifier is not valid
+    identifier string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Interface
    +SilcPublicKeyIdentifier
    +SilcSILCPublicKey
    +SilcSILCPrivateKey
    +silc_pkcs_silc_generate_key
    +silc_pkcs_silc_encode_identifier
    +silc_pkcs_silc_decode_identifier
    +silc_pkcs_silc_public_key_version
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk-silc_pkcs_silc_encode_identifier.html b/docs/toolkit/manual/silcpk-silc_pkcs_silc_encode_identifier.html new file mode 100644 index 0000000..f46eccc --- /dev/null +++ b/docs/toolkit/manual/silcpk-silc_pkcs_silc_encode_identifier.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_silc_encode_identifier

    + + +SYNOPSIS + +
    
+    char *silc_pkcs_silc_encode_identifier(char *username, char *host,
+                                           char *realname, char *email,
+                                           char *org, char *country,
+                                           char *version);
+
+
    +DESCRIPTION + +
    
+    Encodes and returns SILC public key identifier.  If some of the
+    arguments are NULL those are not encoded into the identifier string.
+    Protocol says that at least username and host must be provided.
+    Caller must free the returned identifier string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Interface
    +SilcPublicKeyIdentifier
    +SilcSILCPublicKey
    +SilcSILCPrivateKey
    +silc_pkcs_silc_generate_key
    +silc_pkcs_silc_encode_identifier
    +silc_pkcs_silc_decode_identifier
    +silc_pkcs_silc_public_key_version
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk-silc_pkcs_silc_generate_key.html b/docs/toolkit/manual/silcpk-silc_pkcs_silc_generate_key.html new file mode 100644 index 0000000..346aa7c --- /dev/null +++ b/docs/toolkit/manual/silcpk-silc_pkcs_silc_generate_key.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_silc_generate_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_silc_generate_key(const char *algorithm,
+                                         SilcUInt32 bits_key_len,
+                                         const char *identifier,
+                                         SilcRng rng,
+                                         SilcPublicKey *ret_public_key,
+                                         SilcPrivateKey *ret_private_key)
+
+
    +DESCRIPTION + +
    
+    Generate a new SILC key pair of the algorithm type `algorithm' with
+    the key length in bits of `bits_key_len'.  The `scheme' may be NULL.
+    Returns FALSE if key generation failed.
+
+
    +EXAMPLE + +
    
+    // Generate RSA key pair with 4096 bit key length
+    silc_pkcs_silc_generate_key("rsa", 4096, ident_string, rng,
+                                &public_key, &private_key);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Interface
    +SilcPublicKeyIdentifier
    +SilcSILCPublicKey
    +SilcSILCPrivateKey
    +silc_pkcs_silc_generate_key
    +silc_pkcs_silc_encode_identifier
    +silc_pkcs_silc_decode_identifier
    +silc_pkcs_silc_public_key_version
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk-silc_pkcs_silc_public_key_version.html b/docs/toolkit/manual/silcpk-silc_pkcs_silc_public_key_version.html new file mode 100644 index 0000000..218ac7d --- /dev/null +++ b/docs/toolkit/manual/silcpk-silc_pkcs_silc_public_key_version.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_silc_public_key_version

    + + +SYNOPSIS + +
    
+    int silc_pkcs_silc_public_key_version(SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    Returns the verison of the SILC Public Key indicated by `public_key'.
+    Returns -1 if the `public_key' is not a SILC Public Key and the
+    version number otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Interface
    +SilcPublicKeyIdentifier
    +SilcSILCPublicKey
    +SilcSILCPrivateKey
    +silc_pkcs_silc_generate_key
    +silc_pkcs_silc_encode_identifier
    +silc_pkcs_silc_decode_identifier
    +silc_pkcs_silc_public_key_version
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk.html b/docs/toolkit/manual/silcpk.html new file mode 100644 index 0000000..b50b109 --- /dev/null +++ b/docs/toolkit/manual/silcpk.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcpk.html + + + + +
    + +SILC Public Key Interface
    Header: silcpk.h

    + + +DESCRIPTION + +
    
+ This interface implements the SILC protocol style public key, as defined
+ by the SILC protocol specification.
+
+
  • SilcPublicKeyIdentifier +
  • SilcSILCPublicKey +
  • SilcSILCPrivateKey +
  • silc_pkcs_silc_generate_key +
  • silc_pkcs_silc_encode_identifier +
  • silc_pkcs_silc_decode_identifier +
  • silc_pkcs_silc_public_key_version + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk.xref b/docs/toolkit/manual/silcpk.xref new file mode 100644 index 0000000..1e9994e --- /dev/null +++ b/docs/toolkit/manual/silcpk.xref @@ -0,0 +1,14 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcpk.h" "/home/priikone/silc1/doc/toolkit/silcpk.html" 0 + "SILC Public Key Interface" "/home/priikone/silc1/doc/toolkit/silcpk.html" 1 + "SilcPublicKeyIdentifier" "/home/priikone/silc1/doc/toolkit/silcpk.html" 5 + "SilcSILCPublicKey" "/home/priikone/silc1/doc/toolkit/silcpk.html" 5 + "SilcSILCPrivateKey" "/home/priikone/silc1/doc/toolkit/silcpk.html" 5 + "silc_pkcs_silc_generate_key" "/home/priikone/silc1/doc/toolkit/silcpk.html" 4 + "silc_pkcs_silc_encode_identifier" "/home/priikone/silc1/doc/toolkit/silcpk.html" 4 + "silc_pkcs_silc_decode_identifier" "/home/priikone/silc1/doc/toolkit/silcpk.html" 4 + "silc_pkcs_silc_public_key_version" "/home/priikone/silc1/doc/toolkit/silcpk.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcpk_i.html b/docs/toolkit/manual/silcpk_i.html new file mode 100644 index 0000000..465522d --- /dev/null +++ b/docs/toolkit/manual/silcpk_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcpk_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpk_i.xref b/docs/toolkit/manual/silcpk_i.xref new file mode 100644 index 0000000..4b0d8cd --- /dev/null +++ b/docs/toolkit/manual/silcpk_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcpk_i.h" "/home/priikone/silc1/doc/toolkit/silcpk_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcpkcs-SilcPKCSFileEncoding.html b/docs/toolkit/manual/silcpkcs-SilcPKCSFileEncoding.html new file mode 100644 index 0000000..4388e10 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-SilcPKCSFileEncoding.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcPKCSFileEncoding

    + + +NAME + +
    
+    typedef enum { ... } SilcPKCSType
+
+
    +DESCRIPTION + +
    
+    Public and private key file encoding types.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_PKCS_FILE_BIN,           /* Binary encoding */
+      SILC_PKCS_FILE_BASE64         /* Base64 encoding */
+    } SilcPKCSFileEncoding;
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-SilcPKCSType.html b/docs/toolkit/manual/silcpkcs-SilcPKCSType.html new file mode 100644 index 0000000..a1770c7 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-SilcPKCSType.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcPKCSType

    + + +NAME + +
    
+    typedef enum { ... } SilcPKCSType;
+
+
    +DESCRIPTION + +
    
+    Supported public key cryptosystem types.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_PKCS_SILC    = 1,        /* SILC PKCS */
+      SILC_PKCS_SSH2    = 2,        /* SSH2 PKCS (not supported) */
+      SILC_PKCS_X509V3  = 3,        /* X.509v3 PKCS (not supported) */
+      SILC_PKCS_OPENPGP = 4,        /* OpenPGP PKCS (not supported) */
+      SILC_PKCS_SPKI    = 5,        /* SPKI PKCS (not supported) */
+    } SilcPKCSType;
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-SilcPrivateKey.html b/docs/toolkit/manual/silcpkcs-SilcPrivateKey.html new file mode 100644 index 0000000..939ad73 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-SilcPrivateKey.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPrivateKey

    + + +NAME + +
    
+    typedef struct { ... } *SilcPrivateKey;
+
+
    +DESCRIPTION + +
    
+    This context represents any kind of PKCS private key.
+
+
    +SOURCE + +
        typedef struct SilcPrivateKeyStruct {
+      const SilcPKCSObject *pkcs;   /* PKCS */
+      void *private_key;            /* PKCS specific private key */
+    } *SilcPrivateKey;
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-SilcPublicKey.html b/docs/toolkit/manual/silcpkcs-SilcPublicKey.html new file mode 100644 index 0000000..493f0f1 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-SilcPublicKey.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcPublicKey

    + + +NAME + +
    
+    typedef struct { ... } *SilcPublicKey;
+
+
    +DESCRIPTION + +
    
+    This context represents any kind of PKCS public key.  It can be
+    allocated by silc_pkcs_public_key_alloc and is freed by the
+    silc_pkcs_public_key_free.  The PKCS specific public key context
+    can be retrieved by calling silc_pkcs_get_context.
+
+
    +SOURCE + +
        typedef struct SilcPublicKeyStruct {
+      const SilcPKCSObject *pkcs;   /* PKCS */
+      void *public_key;             /* PKCS specific public key */
+    } *SilcPublicKey;
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_register.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_register.html new file mode 100644 index 0000000..75f44a0 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_register.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_algorithm_register

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_algorithm_register(const SilcPKCSAlgorithm *pkcs);
+
+
    +DESCRIPTION + +
    
+    Registers a new PKCS Algorithm into the SILC.  This function is used
+    at the initialization of the SILC.  All registered PKCS algorithms
+    should be unregistered with silc_pkcs_unregister.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_unregister.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_unregister.html new file mode 100644 index 0000000..10344b5 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_algorithm_unregister.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_algorithm_unregister

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_algorithm_unregister(SilcPKCSAlgorithm *pkcs);
+
+
    +DESCRIPTION + +
    
+    Unregister a PKCS from the SILC. Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_decrypt.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_decrypt.html new file mode 100644 index 0000000..0ac1947 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_decrypt.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_decrypt

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_decrypt(SilcPrivateKey private_key,
+                               unsigned char *src, SilcUInt32 src_len,
+                               unsigned char *dst, SilcUInt32 dst_size,
+                               SilcUInt32 *dst_len);
+
+
    +DESCRIPTION + +
    
+    Decrypts with the private key.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_encrypt.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_encrypt.html new file mode 100644 index 0000000..fa55724 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_encrypt.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_encrypt

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_encrypt(SilcPublicKey public_key,
+                               unsigned char *src, SilcUInt32 src_len,
+                               unsigned char *dst, SilcUInt32 dst_size,
+                               SilcUInt32 *dst_len);
+
+
    +DESCRIPTION + +
    
+    Encrypts with the public key. Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_find_algorithm.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_find_algorithm.html new file mode 100644 index 0000000..2f157e0 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_find_algorithm.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_find_algorithm

    + + +SYNOPSIS + +
    
+    const SilcPKCSAlgorithm *silc_pkcs_find_algorithm(const char *algorithm,
+                                                      const char *scheme);
+
+
    +DESCRIPTION + +
    
+    Finds PKCS algorithm context by the algorithm name `algorithm' and
+    the algorithm scheme `scheme'.  The `scheme' may be NULL.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_find_pkcs.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_find_pkcs.html new file mode 100644 index 0000000..4f04233 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_find_pkcs.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_find_pkcs

    + + +SYNOPSIS + +
    
+    const SilcPKCSObject *silc_pkcs_get_pkcs(SilcPKCSType type);
+
+
    +DESCRIPTION + +
    
+    Finds PKCS context by the PKCS type.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_get_algorithm.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_algorithm.html new file mode 100644 index 0000000..9d776e4 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_algorithm.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_get_algorithm

    + + +SYNOPSIS + +
    
+    const SilcPKCSAlgorithm *silc_pkcs_get_algorithm(void *key);
+
+
    +DESCRIPTION + +
    
+    Returns the PKCS algorithm object from `key', which may be SilcPublicKey
+    or SilcPrivateKey pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_get_context.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_context.html new file mode 100644 index 0000000..07a8385 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_context.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_get_context

    + + +SYNOPSIS + +
    
+    void *silc_pkcs_get_context(SilcPKCSType type, SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    Returns the internal PKCS `type' specific public key context from the
+    `public_key'.  The caller needs to explicitly type cast it to correct
+    type.  Returns NULL on error.
+
+    For SILC_PKCS_SILC the returned context is SilcSILCPublicKey.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_get_name.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_name.html new file mode 100644 index 0000000..968cd7d --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_name.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_get_name

    + + +SYNOPSIS + +
    
+    const char *silc_pkcs_get_name(void *key);
+
+
    +DESCRIPTION + +
    
+    Returns PKCS algorithm name from the `key', which may be SilcPublicKey
+    or SilcPrivateKey pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_get_pkcs.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_pkcs.html new file mode 100644 index 0000000..f685fb4 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_pkcs.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_get_pkcs

    + + +SYNOPSIS + +
    
+    const SilcPKCSObject *silc_pkcs_get_pkcs(void *key);
+
+
    +DESCRIPTION + +
    
+    Returns the PKCS object from `key', which may be SilcPublicKey or
+    SilcPrivateKey pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_get_supported.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_supported.html new file mode 100644 index 0000000..76fa347 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_supported.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_get_supported

    + + +SYNOPSIS + +
    
+    char *silc_pkcs_get_supported(void);
+
+
    +DESCRIPTION + +
    
+    Returns comma separated list of supported PKCS algorithms.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_get_type.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_type.html new file mode 100644 index 0000000..74df187 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_get_type.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_get_type

    + + +SYNOPSIS + +
    
+    SilcPKCSType silc_pkcs_get_type(void *key);
+
+
    +DESCRIPTION + +
    
+    Returns PKCS type from the `key', which may be SilcPublicKey or
+    SilcPrivateKey pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_load_private_key.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_load_private_key.html new file mode 100644 index 0000000..71414bd --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_load_private_key.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_load_private_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_load_private_key(const char *filename,
+                                        const unsigned char *passphrase,
+                                        SilcUInt32 passphrase_len,
+                                        SilcPrivateKey *ret_private_key);
+
+
    +DESCRIPTION + +
    
+    Loads private key from file and allocates new private key.  Returns TRUE
+    if loading was successful.  The `passphrase' is used as decryption
+    key of the private key file, in case it is encrypted.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_load_public_key.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_load_public_key.html new file mode 100644 index 0000000..16c7ff5 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_load_public_key.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_load_public_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_load_public_key(const char *filename,
+                                       SilcPublicKey *ret_public_key);
+
+
    +DESCRIPTION + +
    
+    Loads public key from file and allocates new public key.  Returns TRUE
+    if loading was successful.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_alloc.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_alloc.html new file mode 100644 index 0000000..e07b96e --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_alloc.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_private_key_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_private_key_alloc(SilcPKCSType type,
+                                         unsigned char *key,
+                                         SilcUInt32 key_len,
+                                         SilcPrivateKey *ret_private_key);
+
+
    +DESCRIPTION + +
    
+    Allocates SilcPrivateKey of the type of `type' from the key data
+    `key' of length of `key_len' bytes.  Returns FALSE if the `key'
+    is malformed or unsupported private key type.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_free.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_free.html new file mode 100644 index 0000000..b800356 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_free.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_private_key_free

    + + +SYNOPSIS + +
    
+    void silc_pkcs_private_key_free(SilcPrivateKey private_key;
+
+
    +DESCRIPTION + +
    
+    Frees the private key.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_get_len.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_get_len.html new file mode 100644 index 0000000..2cae2f0 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_private_key_get_len.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_private_key_get_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_pkcs_private_key_get_len(SilcPrivateKey private_key);
+
+
    +DESCRIPTION + +
    
+    Returns the key length in bits from the private key.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_alloc.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_alloc.html new file mode 100644 index 0000000..dd32d74 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_alloc.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_public_key_alloc

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_public_key_alloc(SilcPKCSType type,
+                                        unsigned char *key,
+                                        SilcUInt32 key_len
+                                        SilcPublicKey *ret_public_key);
+
+
    +DESCRIPTION + +
    
+    Allocates SilcPublicKey of the type of `type' from the key data
+    `key' of length of `key_len' bytes.  Returns FALSE if the `key'
+    is malformed or unsupported public key type.  This function can be
+    used to create public key from any kind of PKCS public keys that
+    the implementation supports.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_compare.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_compare.html new file mode 100644 index 0000000..d2dc646 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_compare.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_public_key_compare

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_public_key_compare(SilcPublicKey key1,
+                                          SilcPublicKey key2);
+
+
    +DESCRIPTION + +
    
+    Compares two public keys and returns TRUE if they are same key, and
+    FALSE if they are not same.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_copy.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_copy.html new file mode 100644 index 0000000..17124b3 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_copy.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_public_key_copy

    + + +SYNOPSIS + +
    
+    SilcPublicKey silc_pkcs_public_key_copy(SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    Copies the public key indicated by `public_key' and returns new
+    allocated public key which is indentical to the `public_key'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_export.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_export.html new file mode 100644 index 0000000..058666e --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_export.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_public_key_export

    + + +SYNOPSIS + +
    
+    unsigned char *silc_pkcs_public_key_encode(SilcPublicKey public_key,
+                                               SilcUInt32 *ret_len);
+
+
    +DESCRIPTION + +
    
+    Encodes the `public_key' into a binary format and returns it.  Returns
+    NULL on error.  Caller must free the returned buffer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_free.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_free.html new file mode 100644 index 0000000..eb5ad6e --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_free.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_public_key_free

    + + +SYNOPSIS + +
    
+    void silc_pkcs_public_key_free(SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    Frees the public key.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_get_len.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_get_len.html new file mode 100644 index 0000000..3177bfc --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_public_key_get_len.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_public_key_get_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_pkcs_public_key_get_len(SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    Returns the key length in bits from the public key.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_register.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_register.html new file mode 100644 index 0000000..323cd78 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_register.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_register

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_register(const SilcPKCSObject *pkcs);
+
+
    +DESCRIPTION + +
    
+    Registers a new PKCS into the SILC.  This function is used
+    at the initialization of the SILC.  All registered PKCSs
+    should be unregistered with silc_pkcs_unregister.  The `pkcs' includes
+    the name of the PKCS and member functions for the algorithm.  Usually
+    this function is not called directly.  Instead, application can call
+    the silc_pkcs_register_default to register all PKCSs that are
+    builtin the sources.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_register_default.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_register_default.html new file mode 100644 index 0000000..7be999c --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_register_default.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_register_default

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_register_default(void);
+
+
    +DESCRIPTION + +
    
+    Registers all the default PKCS (all builtin PKCS) and PKCS algorithms.
+    The application may use this to register the default PKCS if specific
+    PKCS in any specific order is not wanted.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_save_private_key.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_save_private_key.html new file mode 100644 index 0000000..397e32d --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_save_private_key.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_save_private_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_save_private_key(const char *filename,
+                                        SilcPrivateKey private_key,
+                                        const unsigned char *passphrase,
+                                        SilcUInt32 passphrase_len,
+                                        SilcPKCSFileEncoding encoding,
+                                        SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Saves private key into file.  The private key is encrypted into
+    the file with the `passphrase' as a key, if PKCS supports encrypted
+    private keys.  Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_save_public_key.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_save_public_key.html new file mode 100644 index 0000000..a992629 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_save_public_key.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_save_public_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_save_public_key(const char *filename,
+                                       SilcPublicKey public_key,
+                                       SilcPKCSFileEncoding encoding);
+
+
    +DESCRIPTION + +
    
+    Saves public key into file with specified encoding.  Returns FALSE
+    on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_sign.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_sign.html new file mode 100644 index 0000000..580c939 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_sign.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_sign

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_sign(SilcPrivateKey private_key,
+                            unsigned char *src, SilcUInt32 src_len,
+                            unsigned char *dst, SilcUInt32 dst_size,
+                            SilcUInt32 *dst_len, SilcBool compute_hash,
+                            SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Generates signature with the private key.  Returns FALSE on error.
+    If `compute_hash' is TRUE the `hash' will be used to compute a
+    digest over the `src'.  The `hash' must always be valid.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_unregister.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_unregister.html new file mode 100644 index 0000000..a0943ba --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_unregister.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_unregister

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_unregister(SilcPKCSObject *pkcs);
+
+
    +DESCRIPTION + +
    
+    Unregister a PKCS from the SILC. Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_unregister_all.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_unregister_all.html new file mode 100644 index 0000000..b37691e --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_unregister_all.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_unregister_all

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_unregister_all(void);
+
+
    +DESCRIPTION + +
    
+    Unregister all PKCS and PKCS algorithms. Returns FALSE on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs-silc_pkcs_verify.html b/docs/toolkit/manual/silcpkcs-silc_pkcs_verify.html new file mode 100644 index 0000000..2db5644 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs-silc_pkcs_verify.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs_verify

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs_verify(SilcPublicKey public_key,
+                              unsigned char *signature,
+                              SilcUInt32 signature_len,
+                              unsigned char *data,
+                              SilcUInt32 data_len, SilcHash hash);
+
+
    +DESCRIPTION + +
    
+    Verifies signature.  Returns FALSE on error.  The 'signature' is
+    verified against the 'data'.  If the `hash' is non-NULL then the `data'
+    will hashed before verification.  If the `hash' is NULL, then the
+    hash algorithm to be used is retrieved from the signature.  If it
+    isn't present in the signature the verification is done as is without
+    hashing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS Interface
    +SilcPKCSType
    +SilcPublicKey
    +SilcPrivateKey
    +SilcPKCSFileEncoding
    +silc_pkcs_register
    +silc_pkcs_unregister
    +silc_pkcs_algorithm_register
    +silc_pkcs_algorithm_unregister
    +silc_pkcs_register_default
    +silc_pkcs_unregister_all
    +silc_pkcs_get_supported
    +silc_pkcs_find_pkcs
    +silc_pkcs_find_algorithm
    +silc_pkcs_get_pkcs
    +silc_pkcs_get_algorithm
    +silc_pkcs_get_name
    +silc_pkcs_get_type
    +silc_pkcs_get_context
    +silc_pkcs_public_key_alloc
    +silc_pkcs_public_key_free
    +silc_pkcs_public_key_export
    +silc_pkcs_public_key_get_len
    +silc_pkcs_public_key_compare
    +silc_pkcs_public_key_copy
    +silc_pkcs_private_key_alloc
    +silc_pkcs_private_key_get_len
    +silc_pkcs_private_key_free
    +silc_pkcs_encrypt
    +silc_pkcs_decrypt
    +silc_pkcs_sign
    +silc_pkcs_verify
    +silc_pkcs_load_public_key
    +silc_pkcs_save_public_key
    +silc_pkcs_load_private_key
    +silc_pkcs_save_private_key
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs.html b/docs/toolkit/manual/silcpkcs.html new file mode 100644 index 0000000..54b9e8e --- /dev/null +++ b/docs/toolkit/manual/silcpkcs.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcpkcs.html + + + + +
    + +SILC PKCS Interface
    Header: silcpkcs.h

    + + +DESCRIPTION + +
    
+ SILC PKCS API provides generic interface for performing various
+ public key cryptography related operations with different types of
+ public and private keys.  Support for loading and saving of different
+ types of public key and private keys are also provided.
+
+
  • SilcPKCSType +
  • SilcPublicKey +
  • SilcPrivateKey +
  • SilcPKCSFileEncoding +
  • silc_pkcs_register +
  • silc_pkcs_unregister +
  • silc_pkcs_algorithm_register +
  • silc_pkcs_algorithm_unregister +
  • silc_pkcs_register_default +
  • silc_pkcs_unregister_all +
  • silc_pkcs_get_supported +
  • silc_pkcs_find_pkcs +
  • silc_pkcs_find_algorithm +
  • silc_pkcs_get_pkcs +
  • silc_pkcs_get_algorithm +
  • silc_pkcs_get_name +
  • silc_pkcs_get_type +
  • silc_pkcs_get_context +
  • silc_pkcs_public_key_alloc +
  • silc_pkcs_public_key_free +
  • silc_pkcs_public_key_export +
  • silc_pkcs_public_key_get_len +
  • silc_pkcs_public_key_compare +
  • silc_pkcs_public_key_copy +
  • silc_pkcs_private_key_alloc +
  • silc_pkcs_private_key_get_len +
  • silc_pkcs_private_key_free +
  • silc_pkcs_encrypt +
  • silc_pkcs_decrypt +
  • silc_pkcs_sign +
  • silc_pkcs_verify +
  • silc_pkcs_load_public_key +
  • silc_pkcs_save_public_key +
  • silc_pkcs_load_private_key +
  • silc_pkcs_save_private_key + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs.xref b/docs/toolkit/manual/silcpkcs.xref new file mode 100644 index 0000000..9f7858c --- /dev/null +++ b/docs/toolkit/manual/silcpkcs.xref @@ -0,0 +1,42 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcpkcs.h" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 0 + "SILC PKCS Interface" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 1 + "SilcPKCSType" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 8 + "SilcPublicKey" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 5 + "SilcPrivateKey" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 5 + "SilcPKCSFileEncoding" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 8 + "silc_pkcs_register" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_unregister" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_algorithm_register" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_algorithm_unregister" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_register_default" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_unregister_all" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_get_supported" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_find_pkcs" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_find_algorithm" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_get_pkcs" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_get_algorithm" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_get_name" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_get_type" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_get_context" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_public_key_alloc" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_public_key_free" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_public_key_export" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_public_key_get_len" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_public_key_compare" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_public_key_copy" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_private_key_alloc" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_private_key_get_len" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_private_key_free" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_encrypt" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_decrypt" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_sign" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_verify" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_load_public_key" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_save_public_key" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_load_private_key" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + "silc_pkcs_save_private_key" "/home/priikone/silc1/doc/toolkit/silcpkcs.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcpkcs1-SilcPkcs1BlockType.html b/docs/toolkit/manual/silcpkcs1-SilcPkcs1BlockType.html new file mode 100644 index 0000000..7c85e9b --- /dev/null +++ b/docs/toolkit/manual/silcpkcs1-SilcPkcs1BlockType.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcPkcs1BlockType

    + + +NAME + +
    
+    typedef enum { ... } SilcPkcs1BlockType
+
+
    +DESCRIPTION + +
    
+    Defines the PKCS#1 block types that define how the blcok is encoded
+    for different RSA operations.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_PKCS1_BT_PRV0 = 0x00,    /* Private key BT 0 */
+      SILC_PKCS1_BT_PRV1 = 0x01,    /* Private key BT 1 (use this always) */
+      SILC_PKCS1_BT_PUB  = 0x02,    /* Public key BT */
+    } SilcPkcs1BlockType;
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS1 Interface
    +SilcPkcs1BlockType
    +silc_pkcs1_encode
    +silc_pkcs1_decode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs1-silc_pkcs1_decode.html b/docs/toolkit/manual/silcpkcs1-silc_pkcs1_decode.html new file mode 100644 index 0000000..186c7fe --- /dev/null +++ b/docs/toolkit/manual/silcpkcs1-silc_pkcs1_decode.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs1_decode

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs1_decode(SilcPkcs1BlockType bt,
+                               const unsigned char *data,
+                               SilcUInt32 data_len,
+                               unsigned char *dest_data,
+                               SilcUInt32 dest_data_size,
+                               SilcUInt32 *dest_len);
+
+
    +DESCRIPTION + +
    
+    Decodes the PKCS#1 encoded block according to the block type `bt'.
+    When verifying signatures the `bt' must be SILC_PKCS1_BT_PRV1 and
+    when decrypting it must be SILC_PKCS1_BT_PUB.  This copies the
+    decoded data into `dest_data' which is size of `dest_data_size'.  If
+    the deocded block does not fit to `dest_data' this returns FALSE.
+    Returns the decoded length into `dest_len'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS1 Interface
    +SilcPkcs1BlockType
    +silc_pkcs1_encode
    +silc_pkcs1_decode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs1-silc_pkcs1_encode.html b/docs/toolkit/manual/silcpkcs1-silc_pkcs1_encode.html new file mode 100644 index 0000000..b7e0fe9 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs1-silc_pkcs1_encode.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_pkcs1_encode

    + + +SYNOPSIS + +
    
+    SilcBool silc_pkcs1_encode(SilcPkcs1BlockType bt,
+                               const unsigned char *data,
+                               SilcUInt32 data_len,
+                               unsigned char *dest_data,
+                               SilcUInt32 dest_data_size,
+                               SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Encodes PKCS#1 data block from the `data' according to the block type
+    indicated by `bt'.  When encoding signatures the `bt' must be
+    SILC_PKCS1_BT_PRV1 and when encoding encryption blocks the `bt' must
+    be SILC_PKCS1_BT_PUB.  The encoded data is copied into the `dest_data'
+    buffer which is size of `dest_data_size'.  If the `dest_data' is not
+    able to hold the encoded block this returns FALSE.  Usually the
+    `dest_data_size' is set to the RSA key length value as it is the
+    length of one block.  The `rng' should be set when `bt' is set to
+    SILC_PKCS1_BT_PUB.  If `rng' is NULL global RNG is used.  This
+    function returns TRUE on success.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC PKCS1 Interface
    +SilcPkcs1BlockType
    +silc_pkcs1_encode
    +silc_pkcs1_decode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs1.html b/docs/toolkit/manual/silcpkcs1.html new file mode 100644 index 0000000..8ca1936 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs1.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcpkcs1.html + + + + +
    + +SILC PKCS1 Interface
    Header: silcpkcs1.h

    + + +DESCRIPTION + +
    
+ This interface implements the PKCS#1 standard block encoding and decoding
+ routines.  It is used as part of RSA implementation to perform PKCS#1
+ RSA operations.  The routines encode and decode the data for RSA operations
+ such as digital signatures and their verification, and encryption and
+ decryption.
+
+
  • SilcPkcs1BlockType +
  • silc_pkcs1_encode +
  • silc_pkcs1_decode + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs1.xref b/docs/toolkit/manual/silcpkcs1.xref new file mode 100644 index 0000000..f5d36d3 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs1.xref @@ -0,0 +1,10 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcpkcs1.h" "/home/priikone/silc1/doc/toolkit/silcpkcs1.html" 0 + "SILC PKCS1 Interface" "/home/priikone/silc1/doc/toolkit/silcpkcs1.html" 1 + "SilcPkcs1BlockType" "/home/priikone/silc1/doc/toolkit/silcpkcs1.html" 8 + "silc_pkcs1_encode" "/home/priikone/silc1/doc/toolkit/silcpkcs1.html" 4 + "silc_pkcs1_decode" "/home/priikone/silc1/doc/toolkit/silcpkcs1.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcpkcs1_i.html b/docs/toolkit/manual/silcpkcs1_i.html new file mode 100644 index 0000000..82b9717 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs1_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcpkcs1_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpkcs1_i.xref b/docs/toolkit/manual/silcpkcs1_i.xref new file mode 100644 index 0000000..3e145f9 --- /dev/null +++ b/docs/toolkit/manual/silcpkcs1_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcpkcs1_i.h" "/home/priikone/silc1/doc/toolkit/silcpkcs1_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcpubkey-silc_public_key_payload_decode.html b/docs/toolkit/manual/silcpubkey-silc_public_key_payload_decode.html new file mode 100644 index 0000000..5851d70 --- /dev/null +++ b/docs/toolkit/manual/silcpubkey-silc_public_key_payload_decode.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_public_key_payload_decode

    + + +SYNOPSIS + +
    
+    SilcBool silc_public_key_payload_decode(unsigned char *data,
+                                            SilcUInt32 data_len,
+                                            SilcPublicKey *public_key);
+
+
    +DESCRIPTION + +
    
+    Decodes Public Key Payload from `data' of `data_len' bytes in length
+    data buffer into `public_key' pointer.  Returns FALSE if the payload
+    cannot be decoded.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Payload
    +silc_public_key_payload_encode
    +silc_public_key_payload_decode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpubkey-silc_public_key_payload_encode.html b/docs/toolkit/manual/silcpubkey-silc_public_key_payload_encode.html new file mode 100644 index 0000000..8473a0f --- /dev/null +++ b/docs/toolkit/manual/silcpubkey-silc_public_key_payload_encode.html @@ -0,0 +1,215 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_public_key_payload_encode

    + + +SYNOPSIS + +
    
+    SilcBool silc_public_key_payload_encode(SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    Encodes the Public Key Payload from the public key indicated by
+    `public_key'.  Returns the allocated and encoded payload buffer,
+    or NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Public Key Payload
    +silc_public_key_payload_encode
    +silc_public_key_payload_decode
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpubkey.html b/docs/toolkit/manual/silcpubkey.html new file mode 100644 index 0000000..c3d7f6f --- /dev/null +++ b/docs/toolkit/manual/silcpubkey.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcpubkey.html + + + + +
    + +SILC Public Key Payload
    Header: silcpubkey.h

    + + +DESCRIPTION + +
    
+ Implementation of the Public Key Payload.  Public Key Payload is used to
+ deliver different types of public keys and certificates in the SILC
+ protocol.
+
+
  • silc_public_key_payload_encode +
  • silc_public_key_payload_decode + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcpubkey.xref b/docs/toolkit/manual/silcpubkey.xref new file mode 100644 index 0000000..d5d73ab --- /dev/null +++ b/docs/toolkit/manual/silcpubkey.xref @@ -0,0 +1,9 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcpubkey.h" "/home/priikone/silc1/doc/toolkit/silcpubkey.html" 0 + "SILC Public Key Payload" "/home/priikone/silc1/doc/toolkit/silcpubkey.html" 1 + "silc_public_key_payload_encode" "/home/priikone/silc1/doc/toolkit/silcpubkey.html" 4 + "silc_public_key_payload_decode" "/home/priikone/silc1/doc/toolkit/silcpubkey.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcrng-SilcRng.html b/docs/toolkit/manual/silcrng-SilcRng.html new file mode 100644 index 0000000..358644c --- /dev/null +++ b/docs/toolkit/manual/silcrng-SilcRng.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcRng

    + + +NAME + +
    
+    typedef struct SilcRngStruct *SilcRng;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Random Number Generator and is allocated
+    by silc_rng_alloc and given as argument usually to all silc_rng_*
+    functions.  It is freed by the silc_rng_free function.  The RNG is
+    initialized by calling the silc_rng_init function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_add_noise.html b/docs/toolkit/manual/silcrng-silc_rng_add_noise.html new file mode 100644 index 0000000..36c6dd6 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_add_noise.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_add_noise

    + + +SYNOPSIS + +
    
+    void silc_rng_add_noise(SilcRng rng, unsigned char *buffer, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Add the data buffer indicated by `buffer' of length of `len' bytes
+    as noise to the random number generator.  The random number generator
+    is restirred (reseeded) when this function is called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_alloc.html b/docs/toolkit/manual/silcrng-silc_rng_alloc.html new file mode 100644 index 0000000..9cd6758 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_alloc.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_alloc

    + + +SYNOPSIS + +
    
+    SilcRng silc_rng_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates new SILC random number generator and returns context to
+    it.  After the RNG is allocated it must be initialized by calling
+    silc_rng_init before it actually can be used to produce any random
+    number.  This function returns NULL if RNG could not allocated.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_free.html b/docs/toolkit/manual/silcrng-silc_rng_free.html new file mode 100644 index 0000000..e6eea1d --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_free.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_free

    + + +SYNOPSIS + +
    
+    void silc_rng_free(SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Frees the random number generator and destroys the random number
+    pool.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_get_byte.html b/docs/toolkit/manual/silcrng-silc_rng_get_byte.html new file mode 100644 index 0000000..3788cdf --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_get_byte.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_get_byte

    + + +SYNOPSIS + +
    
+    SilcUInt8 silc_rng_get_byte(SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Returns one 8-bit random byte from the random number generator.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_get_byte_fast.html b/docs/toolkit/manual/silcrng-silc_rng_get_byte_fast.html new file mode 100644 index 0000000..e8d5ea2 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_get_byte_fast.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_get_byte_fast

    + + +SYNOPSIS + +
    
+    SilcUInt8 silc_rng_get_byte_fast(SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Returns one 8-bit random byte from the random number generator as
+    fast as possible.
+
+
    +NOTES + +
    
+    This will read the data from /dev/urandom if it is available in the
+    operating system, since this may be faster than retrieving a byte
+    from the SILC RNG.  If /dev/urandom is not available this will take
+    the byte from SILC RNG and is effectively same as silc_rng_get_byte.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_get_rn16.html b/docs/toolkit/manual/silcrng-silc_rng_get_rn16.html new file mode 100644 index 0000000..c18cb38 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_get_rn16.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_get_rn16

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_rng_get_rn16(SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Returns one 16-bit random number from the random number generator.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_get_rn32.html b/docs/toolkit/manual/silcrng-silc_rng_get_rn32.html new file mode 100644 index 0000000..e24e377 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_get_rn32.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_get_rn32

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_rng_get_rn32(SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    Returns one 32-bit random number from the random number generator.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_get_rn_data.html b/docs/toolkit/manual/silcrng-silc_rng_get_rn_data.html new file mode 100644 index 0000000..8430017 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_get_rn_data.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_get_rn_data

    + + +SYNOPSIS + +
    
+    unsigned char *silc_rng_get_rn_data(SilcRng rng, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Returns random binary data of the length of `len' bytes.  The
+    caller must free returned data buffer.  It is guaranteed the data
+    buffer does not include any zero (0x00) bytes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_get_rn_string.html b/docs/toolkit/manual/silcrng-silc_rng_get_rn_string.html new file mode 100644 index 0000000..20b5193 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_get_rn_string.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_get_rn_string

    + + +SYNOPSIS + +
    
+    unsigned char *silc_rng_get_rn_string(SilcRng rng, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Returns random string in HEX form of the length of `len' bytes.
+    The caller must free returned data buffer.  It is guaranteed the
+    data string goes not include any zero (0x00) bytes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_add_noise.html b/docs/toolkit/manual/silcrng-silc_rng_global_add_noise.html new file mode 100644 index 0000000..8095f95 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_add_noise.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_add_noise

    + + +SYNOPSIS + +
    
+    void silc_rng_global_add_noise(unsigned char *buffer, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Add the data buffer indicated by `buffer' of length of `len' bytes
+    as noise to the random number generator.  The random number generator
+    is restirred (reseeded) when this function is called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_get_byte.html b/docs/toolkit/manual/silcrng-silc_rng_global_get_byte.html new file mode 100644 index 0000000..3f3d6bd --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_get_byte.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_get_byte

    + + +SYNOPSIS + +
    
+    SilcUInt8 silc_rng_global_get_byte(void);
+
+
    +DESCRIPTION + +
    
+    Returns one 8-bit random byte from the random number generator.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_get_byte_fast.html b/docs/toolkit/manual/silcrng-silc_rng_global_get_byte_fast.html new file mode 100644 index 0000000..d1290fd --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_get_byte_fast.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_get_byte_fast

    + + +SYNOPSIS + +
    
+    SilcUInt8 silc_rng_global_get_byte_fast(void);
+
+
    +DESCRIPTION + +
    
+    Returns one 8-bit random byte from the random number generator as
+    fast as possible.
+
+
    +NOTES + +
    
+    This will read the data from /dev/urandom if it is available in the
+    operating system, since this may be faster than retrieving a byte
+    from the SILC RNG.  If /dev/urandom is not available this will take
+    the byte from SILC RNG and is effectively same as silc_rng_get_byte.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_get_rn16.html b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn16.html new file mode 100644 index 0000000..ead4c44 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn16.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_get_rn16

    + + +SYNOPSIS + +
    
+    SilcUInt16 silc_rng_global_get_rn16(void);
+
+
    +DESCRIPTION + +
    
+    Returns one 16-bit random number from the random number generator.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_get_rn32.html b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn32.html new file mode 100644 index 0000000..1c08161 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn32.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_get_rn32

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_rng_global_get_rn32(void);
+
+
    +DESCRIPTION + +
    
+    Returns one 32-bit random number from the random number generator.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_get_rn_data.html b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn_data.html new file mode 100644 index 0000000..f0b89ec --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn_data.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_get_rn_data

    + + +SYNOPSIS + +
    
+    unsigned char *silc_rng_global_get_rn_data(SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Returns random binary data of the length of `len' bytes.  The
+    caller must free returned data buffer.  It is guaranteed the data
+    buffer does not include any zero (0x00) bytes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_get_rn_string.html b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn_string.html new file mode 100644 index 0000000..0a0e5f5 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_get_rn_string.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_get_rn_string

    + + +SYNOPSIS + +
    
+    unsigned char *silc_rng_global_get_rn_string(SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Returns random string in HEX form of the length of `len' bytes.
+    The caller must free returned data buffer.  It is guaranteed the
+    data string goes not include any zero (0x00) bytes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_init.html b/docs/toolkit/manual/silcrng-silc_rng_global_init.html new file mode 100644 index 0000000..e7285ea --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_init.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_init

    + + +SYNOPSIS + +
    
+    SilcBool silc_rng_global_init(SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    This function sets the `rng' if non-NULL as global RNG context.
+    When any of the silc_rng_global_* functions is called the `rng' is
+    used as RNG.  If `rng' is NULL this will allocate new RNG as global
+    RNG.  The application in this case must free it later by calling
+    silc_rng_global_uninit.  Returns TRUE after Global RNG is initialized.
+
+
    +NOTES + +
    
+    If `rng' was non-NULL, the silc_rng_init must have been called for
+    the `rng' already.
+
+    This function can be used to define the `rng' as global RNG and then
+    use silc_rng_global_* functions easily without need to provide
+    the RNG as argument.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_global_uninit.html b/docs/toolkit/manual/silcrng-silc_rng_global_uninit.html new file mode 100644 index 0000000..7d55670 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_global_uninit.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_global_uninit

    + + +SYNOPSIS + +
    
+    SilcBool silc_rng_global_uninit(void);
+
+
    +DESCRIPTION + +
    
+    Uninitialized the Global RNG object and frees it.  This should not
+    be called if silc_rng_global_init was called with non-NULL RNG.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng-silc_rng_init.html b/docs/toolkit/manual/silcrng-silc_rng_init.html new file mode 100644 index 0000000..f6c1a94 --- /dev/null +++ b/docs/toolkit/manual/silcrng-silc_rng_init.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_rng_init

    + + +SYNOPSIS + +
    
+    void silc_rng_init(SilcRng rng);
+
+
    +DESCRIPTION + +
    
+    This function is used to initialize the random number generator.
+    This is the function that must be called after the RNG is allocated
+    by calling silc_rng_alloc.  RNG cannot be used before this function
+    is called.
+
+
    +NOTES + +
    
+    This function may be slow since it will acquire secret noise from
+    the environment in an attempt to set the RNG in unguessable state.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC RNG Interface
    +SilcRng
    +silc_rng_alloc
    +silc_rng_free
    +silc_rng_init
    +silc_rng_get_byte
    +silc_rng_get_byte_fast
    +silc_rng_get_rn16
    +silc_rng_get_rn32
    +silc_rng_get_rn_string
    +silc_rng_get_rn_data
    +silc_rng_add_noise
    +silc_rng_global_init
    +silc_rng_global_uninit
    +silc_rng_global_get_byte
    +silc_rng_global_get_byte_fast
    +silc_rng_global_get_rn16
    +silc_rng_global_get_rn32
    +silc_rng_global_get_rn_string
    +silc_rng_global_get_rn_data
    +silc_rng_global_add_noise
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng.html b/docs/toolkit/manual/silcrng.html new file mode 100644 index 0000000..cb4e894 --- /dev/null +++ b/docs/toolkit/manual/silcrng.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcrng.html + + + + +
    + +SILC RNG Interface
    Header: silcrng.h

    + + +DESCRIPTION + +
    
+ SILC Random Number Generator is cryptographically strong pseudo random
+ number generator. It is used to generate all the random numbers needed
+ in the SILC sessions. All key material and other sources needing random
+ numbers use this generator.
+
+ The interface provides functions for retrieving different size of
+ random number and arbitrary length of random data buffers. The interface
+ also defines Global RNG API which makes it possible to call any
+ RNG API function without specific RNG context.
+
+
  • SilcRng +
  • silc_rng_alloc +
  • silc_rng_free +
  • silc_rng_init +
  • silc_rng_get_byte +
  • silc_rng_get_byte_fast +
  • silc_rng_get_rn16 +
  • silc_rng_get_rn32 +
  • silc_rng_get_rn_string +
  • silc_rng_get_rn_data +
  • silc_rng_add_noise +
  • silc_rng_global_init +
  • silc_rng_global_uninit +
  • silc_rng_global_get_byte +
  • silc_rng_global_get_byte_fast +
  • silc_rng_global_get_rn16 +
  • silc_rng_global_get_rn32 +
  • silc_rng_global_get_rn_string +
  • silc_rng_global_get_rn_data +
  • silc_rng_global_add_noise + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcrng.xref b/docs/toolkit/manual/silcrng.xref new file mode 100644 index 0000000..fc2c996 --- /dev/null +++ b/docs/toolkit/manual/silcrng.xref @@ -0,0 +1,27 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcrng.h" "/home/priikone/silc1/doc/toolkit/silcrng.html" 0 + "SILC RNG Interface" "/home/priikone/silc1/doc/toolkit/silcrng.html" 1 + "SilcRng" "/home/priikone/silc1/doc/toolkit/silcrng.html" 5 + "silc_rng_alloc" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_free" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_init" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_get_byte" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_get_byte_fast" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_get_rn16" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_get_rn32" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_get_rn_string" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_get_rn_data" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_add_noise" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_init" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_uninit" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_get_byte" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_get_byte_fast" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_get_rn16" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_get_rn32" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_get_rn_string" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_get_rn_data" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + "silc_rng_global_add_noise" "/home/priikone/silc1/doc/toolkit/silcrng.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcrng_intro.html b/docs/toolkit/manual/silcrng_intro.html new file mode 100644 index 0000000..b87e665 --- /dev/null +++ b/docs/toolkit/manual/silcrng_intro.html @@ -0,0 +1,365 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +Introduction to Random Number Generator + +
     
     
    +Overview + +
     
    +SILC Random Number Generator is cryptographically strong pseudo random +number generator. It is used to generate all the random numbers needed +in the SILC sessions. All key material and other sources needing random +numbers use this generator. + +
     
    +The RNG has a random pool of 1024 bytes of size that provides the actual +random numbers for the application. The pool is initialized when the +RNG is allocated and initialized with silc_rng_alloc and silc_rng_init +functions, respectively. + + +
     
     
    +Random Pool Initialization + +
     
    +The RNG's random pool is the source of all random output data. The pool is +initialized with silc_rng_init and application can reseed it at any time +by calling the silc_rng_add_noise function. + +
     
    +The initializing phase attempts to set the random pool in a state that it +is impossible to learn the input data to the RNG or any random output +data. This is achieved by acquiring noise from various system sources. The +first source is called to provide "soft noise". This noise is various +data from system's processes. The second source is called to provide +"medium noise". This noise is various output data from executed commands. +Usually the commands are Unix `ps' and `ls' commands with various options. +The last source is called to provide "hard noise" and is noise from +system's /dev/random, if it exists. + + +
     
     
    +Stirring the Random Pool + +
     
    +Every time data is acquired from any source, the pool is stirred. The +stirring process performs an CFB (cipher feedback) encryption with SHA1 +algorithm to the entire random pool. First it acquires an IV (Initial +Vector) from the constant (random) location of the pool and performs +the first CFB pass. Then it acquires a new encryption key from variable +location of the pool and performs the second CFB pass. The encryption +key thus is always acquired from unguessable data. + +
     
    +The encryption process to the entire random pool assures that it is +impossible to learn the input data to the random pool without breaking the +encryption process. This would effectively mean breaking the SHA1 hash +function. The encryption process also assures that each random output from +the random pool is secured with cryptographically strong function, the +SHA1 in this case. + +
     
    +The random pool can be restirred by the application at any point by +calling the silc_rng_add_noise function. This function adds new noise to +the pool and then stirs the entire pool. + + +
     
     
    +Stirring Thresholds + +
     
    +The random pool has two thresholds that controls when the random pool +needs more new noise and requires restirring. As previously mentioned, the +application may do this by calling the silc_rng_add_noise. However, the +RNG performs this also automatically. + +
     
    +The first threshold gets soft noise from system and stirs the random pool. +The threshold is reached after 64 bits of random data has been fetched +from the RNG. After the 64 bits, the soft noise acquiring and restirring +process is performed every 8 bits of random output data until the second +threshold is reached. + +
     
    +The second threshold gets hard noise from system and stirs the random +pool. The threshold is reached after 160 bits of random output. After the +noise is acquired (from /dev/urandom) the random pool is stirred and the +thresholds are set to zero. The process is repeated again after 64 bits of +output for first threshold and after 160 bits of output for the second +threshold. + + +
     
     
    +Internal State of the Random Pool + +
     
    +The random pool has also internal state that provides several variable +distinct points to the random pool where the data is fetched. The state +changes every 8 bits of output data and it is guaranteed that the fetched +8 bits of data is from distinct location compared to the previous 8 bits. +It is also guaranteed that the internal state never wraps before +restirring the entire random pool. The internal state means that the data +is not fetched linearly from the pool, eg. starting from zero and wrapping +at the end of the pool. The internal state is not dependent of any random +data in the pool. The internal states are initialized (by default the pool +is splitted to four different sections (states)) at the RNG +initialization phase. The state's current position is added linearly and +wraps at the the start of the next state. The states provides the distinct +locations. + + +
     
     
    +Security Considerations + +
     
    +The security of this random number generator, like of any other RNG's, +depends of the initial state of the RNG. The initial state of the random +number generators must be unknown to an adversary. This means that after +the RNG is initialized it is required that the input data to the RNG and +the output data to the application has no correlation of any kind that +could be used to compromise the acquired random numbers or any future +random numbers. + +
     
    +It is, however, clear that the correlation exists but it needs to be +hard to solve for an adversary. To accomplish this the input data to the +random number generator needs to be secret. Usually this is impossible to +achieve. That is why SILC's RNG acquires the noise from three different +sources and provides for the application an interface to add more noise at +any time. The first source ("soft noise") is known to the adversary but +requires exact timing to get all of the input data. However, getting only +partial data is easy. The second source ("medium noise") depends on the +place of execution of the application. Getting at least partial data is +easy but securing for example the user's home directory from outside access +makes it harder. The last source ("hard noise") is considered to be the +most secure source of data. An adversary is not considered to have any +access on this data. This of course greatly depends on the operating system. + +
     
    +These three sources are considered to be adequate since the random pool is +relatively large and the output of each bit of the random pool is secured +by cryptographically secure function, the SHA1 in CFB mode encryption. +Furthermore the application may provide other random data, such as random +key strokes or mouse movement to the RNG. However, it is recommended that +the application would not be the single point of source for the RNG, in +either intializing or reseeding phases later in the session. Good solution +is probably to use both, the application's seeds and the RNG's own +sources, equally. + +
     
    +The RNG must also assure that any old or future random numbers are not +compromised if an adversary would learn the initial input data (or any +input data for that matter). The SILC's RNG provides good protection for +this even if the some of the input bits would be compromised for old or +future random numbers. The RNG reinitalizes (reseeds) itself using the +thresholds after every 64 and 160 bits of output. This is considered to be +adequate even if some of the bits would get compromised. Also, the +applications that use the RNG usually fetches at least 256 bits from the +RNG. This means that everytime RNG is accessed both of the thresholds are +reached. This should mean that the RNG is never too long in an compromised +state and recovers as fast as possible. + + +
     
     
    +Caveat Windows Programmer + +
     
    +The caller must be cautios when using this RNG with native WIN32 system. +The RNG most likely is impossible to set in unguessable state just by +using the RNG's input data sources. On WIN32 it is stronly suggested +that caller would add more random noise after the initialization of the +RNG using the silc_rng_add_noise function. For example, random mouse +movements may be used. + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-SILC_ALL_TASKS.html b/docs/toolkit/manual/silcschedule-SILC_ALL_TASKS.html new file mode 100644 index 0000000..f2ad29f --- /dev/null +++ b/docs/toolkit/manual/silcschedule-SILC_ALL_TASKS.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_ALL_TASKS

    + + +NAME + +
    
+    #define SILC_ALL_TASKS ...
+
+
    +DESCRIPTION + +
    
+    Marks for all tasks in the scheduler. This can be passed to
+    silc_schedule_task_del function to delete all tasks at once.
+
+
    +SOURCE + +
        #define SILC_ALL_TASKS ((SilcTask)1)
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-SILC_TASK_CALLBACK.html b/docs/toolkit/manual/silcschedule-SILC_TASK_CALLBACK.html new file mode 100644 index 0000000..88d0072 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-SILC_TASK_CALLBACK.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_TASK_CALLBACK

    + + +NAME + +
    
+    #define SILC_TASK_CALLBACK ...
+
+
    +DESCRIPTION + +
    
+    Generic macro to declare task callback functions. This defines a
+    function with name `func' as a task callback function.
+
+
    +SOURCE + +
        #define SILC_TASK_CALLBACK(func)                                        \
+    void func(SilcSchedule schedule, void *app_context, SilcTaskEvent type, \
+              SilcUInt32 fd, void *context)
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-SilcSchedule.html b/docs/toolkit/manual/silcschedule-SilcSchedule.html new file mode 100644 index 0000000..4d63131 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-SilcSchedule.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSchedule

    + + +NAME + +
    
+    typedef struct SilcScheduleStruct *SilcSchedule;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Scheduler and is allocated by
+    the silc_schedule_init funtion.  The context is given as argument
+    to all silc_schedule_* functions.  It must be freed by the
+    silc_schedule_uninit function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-SilcTask.html b/docs/toolkit/manual/silcschedule-SilcTask.html new file mode 100644 index 0000000..fbef89e --- /dev/null +++ b/docs/toolkit/manual/silcschedule-SilcTask.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcTask

    + + +NAME + +
    
+    typedef struct SilcTaskStruct *SilcTask;
+
+
    +DESCRIPTION + +
    
+    This object represents one task in the scheduler.  It is allocated
+    by the silc_schedule_task_add function and freed by one of the
+    silc_schedule_task_del* functions.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-SilcTaskCallback.html b/docs/toolkit/manual/silcschedule-SilcTaskCallback.html new file mode 100644 index 0000000..63b1749 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-SilcTaskCallback.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcTaskCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcTaskCallback)(SilcSchedule schedule,
+                                     void *app_context,
+                                     SilcTaskEvent type, SilcUInt32 fd,
+                                     void *context);
+
+
    +DESCRIPTION + +
    
+    The task callback function.  This function will be called by the
+    scheduler when some event of the task is performed.  For example,
+    when data is available from the connection this will be called.
+
+    The `schedule' is the scheduler context, the `type' is the indicated
+    event, the `fd' is the file descriptor of the task and the `context'
+    is a caller specified context. If multiple events occurred this
+    callback is called separately for all events.  The `app_context'
+    is application specific context that was given as argument to the
+    silc_schedule_init function.  If the task is timeout task then `fd'
+    is zero (0).
+
+    To specify task callback function in the application using the
+    SILC_TASK_CALLBACK macro is recommended.
+
+    The callback should not perform lenghty or blocking operations as
+    this would also block all other waiting tasks.  The task callback
+    should either handle the operation fast or issue an asynchronous
+    call (like to register 0 timeout task) to handle it later.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-SilcTaskEvent.html b/docs/toolkit/manual/silcschedule-SilcTaskEvent.html new file mode 100644 index 0000000..2ccd072 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-SilcTaskEvent.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcTaskEvent

    + + +NAME + +
    
+    typedef enum { ... } SilcTaskEvent;
+
+
    +DESCRIPTION + +
    
+    SILC Task event types.  The event type indicates the occurred
+    event of the task.  This type will be given as argument to the
+    SilcTaskCallback function to indicate the event for the caller.
+    The SILC_TASK_READ and SILC_TASK_WRITE may be set by the caller
+    of the silc_schedule_set_listen_fd, if the caller needs to control
+    the events for the task. The SILC_TASK_EXPIRE is set always only
+    by the scheduler when timeout expires for timeout task.  The
+    SILC_TASK_INTERRUPT is set for signal callback.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_TASK_READ         = 0x0001,               /* Reading */
+      SILC_TASK_WRITE        = 0x0002,               /* Writing */
+      SILC_TASK_EXPIRE       = 0x0004,               /* Timeout */
+      SILC_TASK_INTERRUPT    = 0x0008,               /* Signal */
+    } SilcTaskEvent;
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-SilcTaskNotifyCb.html b/docs/toolkit/manual/silcschedule-SilcTaskNotifyCb.html new file mode 100644 index 0000000..8a40d72 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-SilcTaskNotifyCb.html @@ -0,0 +1,264 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcTaskNotifyCb

    + + +SYNOPSIS + +
    
+    typedef void (*SilcTaskNotifyCb)(SilcSchedule schedule,
+                                     SilcBool added, SilcTask task,
+                                     SilcBool fd_task, SilcUInt32 fd,
+                                     SilcTaskEvent event,
+                                     long seconds, long useconds,
+                                     void *context);
+
+
    +DESCRIPTION + +
    
+    Task notify callback.  Callback of this type can be set to scheduler
+    by calling silc_schedule_set_notify and will be called whenever new
+    task is added or old task is removed.  If `added' is TRUE then `task'
+    is added to scheduler.  If `added' is FALSE then `task' will be removed
+    from the scheduler.  If `fd_task' is TRUE the `task' is file descriptor
+    task and has `fd' is its file descriptor.  If `fd_task' is FALSE then
+    the task is timeout task and `seconds' and `useconds' specify the
+    timeout.  The `context' is the context given to silc_schedule_set_notify.
+
+
    +NOTES + +
    
+    The `schedule' is locked while this callback is called.  This means that
+    new tasks cannot be added or removed inside this callback.
+
+    When timeout task expires this callback is not called.  This is called
+    only when task is explicitly deleted from the scheduler.  Note that,
+    when timeout task expires it is removed from the scheduler and `task'
+    will become invalid.
+
+    If fd task changes its events, this will be called as if it was a new
+    task with different `event' mask.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule.html b/docs/toolkit/manual/silcschedule-silc_schedule.html new file mode 100644 index 0000000..e518e33 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule

    + + +SYNOPSIS + +
    
+    void silc_schedule(SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    The SILC scheduler.  The program will run inside this function.
+    When this returns the program is to be ended.  Before this function
+    can be called, one must call silc_schedule_init function.
+
+
    +NOTES + +
    
+    On Windows this will block the calling thread but will continue
+    to dispatch window messages, and thus can be used as the main loop
+    of the program.
+
+    On Symbian this will block the calling thread.  The Symbian Active
+    Scheduler must be running before calling this function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_get_context.html b/docs/toolkit/manual/silcschedule-silc_schedule_get_context.html new file mode 100644 index 0000000..3015e66 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_get_context.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_get_context

    + + +SYNOPSIS + +
    
+    void *silc_schedule_get_context(SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Returns the application specific context that was saved into the
+    scheduler in silc_schedule_init function.  The context is also
+    returned to application in the SilcTaskCallback, but this function
+    may be used to get it as well if needed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_get_fd_events.html b/docs/toolkit/manual/silcschedule-silc_schedule_get_fd_events.html new file mode 100644 index 0000000..b3c57d6 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_get_fd_events.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_get_fd_events

    + + +SYNOPSIS + +
    
+    SilcTaskEvent silc_schedule_get_fd_events(SilcSchedule schedule,
+                                              SilcUInt32 fd);
+
+
    +DESCRIPTION + +
    
+    Returns the file descriptor `fd' current requested events mask,
+    or 0 on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_init.html b/docs/toolkit/manual/silcschedule-silc_schedule_init.html new file mode 100644 index 0000000..0fc37a4 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_init.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_init

    + + +SYNOPSIS + +
    
+    SilcSchedule silc_schedule_init(int max_tasks, void *app_context);
+
+
    +DESCRIPTION + +
    
+    Initializes the scheduler. This returns the scheduler context that
+    is given as argument usually to all silc_schedule_* functions.
+    The `app_context' is application specific context that is delivered
+    to all task callbacks. The caller must free that context.  The
+    'app_context' can be for example the application itself.
+
+    The `max_tasks' is the maximum number of file descriptor and socket
+    tasks in the scheduler.  Set value to 0 to use default.  Operating
+    system will enforce the final limit.  On some operating systems the
+    limit can be significantly increased when this function is called in
+    priviliged mode (as super user).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_one.html b/docs/toolkit/manual/silcschedule-silc_schedule_one.html new file mode 100644 index 0000000..bbaa585 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_one.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_one

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_one(SilcSchedule schedule, int timeout_usecs);
+
+
    +DESCRIPTION + +
    
+    Same as the silc_schedule but runs the scheduler only one round
+    and then returns.  This function is handy when the SILC scheduler
+    is used inside some other external scheduler, for example.  If
+    the `timeout_usecs' is non-negative a timeout will be added to the
+    scheduler.  The function will not return in this timeout unless
+    some other event occurs.
+
+    Typically this would be called from a timeout or idle task
+    periodically (typically from 5-50 ms) to schedule SILC tasks.  In
+    this case the `timeout_usecs' is usually 0 to make the function
+    return immediately.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_set_listen_fd.html b/docs/toolkit/manual/silcschedule-silc_schedule_set_listen_fd.html new file mode 100644 index 0000000..e5d5f8c --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_set_listen_fd.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_set_listen_fd

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_set_listen_fd(SilcSchedule schedule,
+                                         SilcUInt32 fd,
+                                         SilcTaskEvent mask,
+                                         SilcBool send_events);
+
+
    +DESCRIPTION + +
    
+    Sets a file descriptor `fd' to be listened by the scheduler for
+    `mask' events.  To tell scheduler not to listen anymore for this
+    file descriptor call the silc_schedule_unset_listen_fd function.
+    When new task is created with silc_schedule_task_add the event
+    for the task's fd is initially set to SILC_TASK_READ. If you need
+    to control the task's fd's events you must call this function
+    whenever you need to change the events. This can be called multiple
+    times to change the events.
+
+    If the `send_events' is TRUE then this function sends the events
+    in `mask' to the application.  If FALSE then they are sent only
+    after the event occurs in reality.  In normal cases the `send_events'
+    is set to FALSE.
+
+    Returns FALSE if the operation could not performed and TRUE if it
+    was a success.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_set_notify.html b/docs/toolkit/manual/silcschedule-silc_schedule_set_notify.html new file mode 100644 index 0000000..a64d5a3 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_set_notify.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_set_notify

    + + +SYNOPSIS + +
    
+    void silc_schedule_set_notify(SilcSchedule schedule,
+                                  SilcTaskNotifyCb notify, void *context);
+
+
    +DESCRIPTION + +
    
+    Set notify callback to scheduler.  The `notify' will be called whenever
+    task is added to or deleted from scheduler.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_stop.html b/docs/toolkit/manual/silcschedule-silc_schedule_stop.html new file mode 100644 index 0000000..f45cf81 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_stop.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_stop

    + + +SYNOPSIS + +
    
+    void silc_schedule_stop(SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Stops the scheduler even if it is not supposed to be stopped yet.
+    After calling this, one must call silc_schedule_uninit (after the
+    silc_schedule has returned).  After this is called it is guaranteed
+    that next time the scheduler enters the main loop it will be stopped.
+    However, untill it enters the main loop it will not detect that
+    it is stopped for example if this is called from another thread.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_add_fd.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_add_fd.html new file mode 100644 index 0000000..a4882b5 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_add_fd.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_add_fd

    + + +SYNOPSIS + +
    
+    SilcTask
+    silc_schedule_task_add_fd(SilcSchedule schedule, SilcUInt32 fd,
+                              SilcTaskCallback callback, void *context);
+
+
    +DESCRIPTION + +
    
+    Add file descriptor task to scheduler.  The `fd' may be either real
+    file descriptor, socket or on some platforms an opaque file descriptor
+    handle.  To receive events for the file descriptor set the correct
+    request events with silc_schedule_set_listen_fd function.
+
+    The task will be initially set for SILC_TASK_READ events.  Setting that
+    event immediately after this call returns is not necessary.
+
+    This returns the new task or NULL on error.  If a task with `fd' has
+    already been added this will return the existing task pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_add_signal.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_add_signal.html new file mode 100644 index 0000000..5f61458 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_add_signal.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_add_signal

    + + +SYNOPSIS + +
    
+    SilcTask
+    silc_schedule_task_add_signal(SilcSchedule schedule, int signal,
+                                  SilcTaskCallback callback, void *context);
+
+
    +DESCRIPTION + +
    
+    Add platform specific process signal handler to scheduler.  On Unix
+    systems the `signal' is one of the signal specified in signal(7).  On
+    other platforms this function may not be available at all, and has no
+    effect when called.  The event delivered to the `callback' is
+    SILC_TASK_INTERRUPT.
+
+
    +NOTES + +
    
+    One signal may be registered only one callback.  Adding second callback
+    for signal that already has one will fail.
+
+    This function always returns NULL.  To remove signal from scheduler by
+    the signal call silc_schedule_task_del_by_fd.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_add_timeout.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_add_timeout.html new file mode 100644 index 0000000..ca6ef63 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_add_timeout.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_add_timeout

    + + +SYNOPSIS + +
    
+    SilcTask
+    silc_schedule_task_add_timeout(SilcSchedule schedule,
+                                   SilcTaskCallback callback, void *context,
+                                   long seconds, long useconds);
+
+
    +DESCRIPTION + +
    
+    Add timeout task to scheduler.  The `callback' will be called once
+    the specified timeout has elapsed.  The task will be removed from the
+    scheduler automatically once the task expires.  The event returned
+    to the `callback' is SILC_TASK_EXPIRE.  A task added with zero (0)
+    timeout will be executed immediately next time tasks are scheduled.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_del.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_del.html new file mode 100644 index 0000000..78967c5 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_del.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_del

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_task_del(SilcSchedule schedule, SilcTask task);
+
+
    +DESCRIPTION + +
    
+    Deletes the `task' from the scheduler indicated by the `schedule'.
+    After deleting the task it is guaranteed that the task callback
+    will not be called. If the `task' is SILC_ALL_TASKS then all
+    tasks is removed from the scheduler.  Returns always TRUE.
+
+    It is safe to call this function in any place. Tasks may be removed
+    in task callbacks (including in the task's own task callback) and
+    in multi-threaded environment in other threads as well.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_all.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_all.html new file mode 100644 index 0000000..76f4552 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_all.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_del_by_all

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_task_del_by_all(SilcSchedule schedule, int fd,
+                                           SilcTaskCallback callback,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    Deletes a task from the scheduler by the specified `fd', `callback'
+    and `context'.  Returns FALSE if such task does not exist.
+
+    It is safe to call this function in any place. Tasks may be removed
+    in task callbacks (including in the task's own task callback) and
+    in multi-threaded environment in other threads as well.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_callback.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_callback.html new file mode 100644 index 0000000..07e6ed0 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_callback.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_del_by_callback

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_task_del_by_callback(SilcSchedule schedule,
+                                                SilcTaskCallback callback);
+
+
    +DESCRIPTION + +
    
+    Deletes a task from the scheduler by the specified `callback' task
+    callback function.  Returns FALSE if such task with such callback
+    does not exist.
+
+    It is safe to call this function in any place. Tasks may be removed
+    in task callbacks (including in the task's own task callback) and
+    in multi-threaded environment in other threads as well.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_context.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_context.html new file mode 100644 index 0000000..2e905a7 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_context.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_del_by_context

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_task_del_by_context(SilcSchedule schedule,
+                                               void *context);
+
+
    +DESCRIPTION + +
    
+    Deletes a task from the scheduler by the specified `context'.  Returns
+    FALSE if such task with such context does not exist.
+
+    It is safe to call this function in any place. Tasks may be removed
+    in task callbacks (including in the task's own task callback) and
+    in multi-threaded environment in other threads as well.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_fd.html b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_fd.html new file mode 100644 index 0000000..e60a578 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_task_del_by_fd.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_task_del_by_fd

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_task_del_by_fd(SilcSchedule schedule,
+                                          SilcUInt32 fd);
+
+
    +DESCRIPTION + +
    
+    Deletes a task from the scheduler by the specified `fd'.  Returns
+    FALSE if such fd task does not exist.
+
+    It is safe to call this function in any place. Tasks may be removed
+    in task callbacks (including in the task's own task callback) and
+    in multi-threaded environment in other threads as well.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_uninit.html b/docs/toolkit/manual/silcschedule-silc_schedule_uninit.html new file mode 100644 index 0000000..872d4ac --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_uninit.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_uninit

    + + +SYNOPSIS + +
    
+    SilcBool silc_schedule_uninit(SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Uninitializes the scheduler. This is called when the program is ready
+    to end. This removes all tasks from the scheduler. Returns FALSE if the
+    scheduler could not be uninitialized. This happens when the scheduler
+    is still valid and silc_schedule_stop has not been called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_unset_listen_fd.html b/docs/toolkit/manual/silcschedule-silc_schedule_unset_listen_fd.html new file mode 100644 index 0000000..6770fb5 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_unset_listen_fd.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_unset_listen_fd

    + + +SYNOPSIS + +
    
+    void silc_schedule_unset_listen_fd(SilcSchedule schedule, SilcUInt32 fd);
+
+
    +DESCRIPTION + +
    
+    Tells the scheduler not to listen anymore for the specified
+    file descriptor `fd'. No events will be detected for the `fd'
+    after calling this function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule-silc_schedule_wakeup.html b/docs/toolkit/manual/silcschedule-silc_schedule_wakeup.html new file mode 100644 index 0000000..4ad6297 --- /dev/null +++ b/docs/toolkit/manual/silcschedule-silc_schedule_wakeup.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_schedule_wakeup

    + + +SYNOPSIS + +
    
+    void silc_schedule_wakeup(SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Wakes up the scheduler. This is may be used in multi-threaded
+    environments where threads may add new tasks or remove old tasks
+    from the scheduler. This is called to wake up the scheduler in the
+    main thread so that it detects the changes in the scheduler.
+    If threads support is not compiled in this function has no effect.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Schedule Interface
    +SilcSchedule
    +SilcTask
    +SilcTaskEvent
    +SilcTaskCallback
    +SilcTaskNotifyCb
    +SILC_ALL_TASKS
    +SILC_TASK_CALLBACK
    +silc_schedule_init
    +silc_schedule_uninit
    +silc_schedule_stop
    +silc_schedule
    +silc_schedule_one
    +silc_schedule_wakeup
    +silc_schedule_get_context
    +silc_schedule_set_notify
    +silc_schedule_task_add_fd
    +silc_schedule_task_add_timeout
    +silc_schedule_task_add_signal
    +silc_schedule_task_del
    +silc_schedule_task_del_by_fd
    +silc_schedule_task_del_by_callback
    +silc_schedule_task_del_by_context
    +silc_schedule_task_del_by_all
    +silc_schedule_set_listen_fd
    +silc_schedule_get_fd_events
    +silc_schedule_unset_listen_fd
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule.html b/docs/toolkit/manual/silcschedule.html new file mode 100644 index 0000000..5b87057 --- /dev/null +++ b/docs/toolkit/manual/silcschedule.html @@ -0,0 +1,274 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcschedule.html + + + + +
    + +SILC Schedule Interface
    Header: silcschedule.h

    + + +DESCRIPTION + +
    
+ The SILC Scheduler is the heart of any application. The scheduler provides
+ the application's main loop that can handle incoming data, outgoing data,
+ timeouts and dispatch different kind of tasks.
+
+ The SILC Scheduler supports file descriptor based tasks and timeout tasks.
+ File descriptor tasks are tasks that perform some operation over the
+ specified file descriptor. These include network connections, for example.
+ The timeout tasks are timeouts that are executed after the specified
+ timeout has elapsed.
+
+ The SILC Scheduler is designed to be the sole main loop of the application
+ so that the application does not need any other main loop.  However,
+ SILC Scheduler does support running the scheduler only once, so that the
+ scheduler does not block, and thus providing a possiblity that some
+ external main loop is run over the SILC Scheduler.
+
+ Typical application first initializes the scheduler and then registers
+ the very first tasks to the scheduler and then run the scheduler.  After
+ the scheduler's run function returns the application is considered to be
+ ended.
+
+ On WIN32 systems the SILC Scheduler is too designed to work as the main
+ loop of the GUI application. It can handle all Windows messages and
+ it dispatches them from the scheduler, and thus makes it possible to
+ create GUI applications. The scheduler can also handle all kinds of
+ WIN32 handles, this includes sockets created by the SILC Net API routines,
+ WSAEVENT handle objects created by Winsock2 routines and arbitrary
+ WIN32 HANDLE objects.
+
+ The SILC Scheduler supports multi-threads as well. The actual scheduler
+ must be run in single-thread but other threads may register new tasks
+ and unregister old tasks.  However, it is enforced that the actual
+ task is always run in the main thread.  The scheduler is context based
+ which makes it possible to allocate several schedulers for one application.
+ Since the scheduler must be run in single-thread, a multi-threaded
+ application could be created by allocating own scheduler for each of the
+ worker threads.
+
+
  • SilcSchedule +
  • SilcTask +
  • SilcTaskEvent +
  • SilcTaskCallback +
  • SilcTaskNotifyCb +
  • SILC_ALL_TASKS +
  • SILC_TASK_CALLBACK +
  • silc_schedule_init +
  • silc_schedule_uninit +
  • silc_schedule_stop +
  • silc_schedule +
  • silc_schedule_one +
  • silc_schedule_wakeup +
  • silc_schedule_get_context +
  • silc_schedule_set_notify +
  • silc_schedule_task_add_fd +
  • silc_schedule_task_add_timeout +
  • silc_schedule_task_add_signal +
  • silc_schedule_task_del +
  • silc_schedule_task_del_by_fd +
  • silc_schedule_task_del_by_callback +
  • silc_schedule_task_del_by_context +
  • silc_schedule_task_del_by_all +
  • silc_schedule_set_listen_fd +
  • silc_schedule_get_fd_events +
  • silc_schedule_unset_listen_fd + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule.xref b/docs/toolkit/manual/silcschedule.xref new file mode 100644 index 0000000..82fe812 --- /dev/null +++ b/docs/toolkit/manual/silcschedule.xref @@ -0,0 +1,33 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcschedule.h" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 0 + "SILC Schedule Interface" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 1 + "SilcSchedule" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 5 + "SilcTask" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 5 + "SilcTaskEvent" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 8 + "SilcTaskCallback" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "SilcTaskNotifyCb" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "SILC_ALL_TASKS" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 8 + "SILC_TASK_CALLBACK" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 8 + "silc_schedule_init" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_uninit" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_stop" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_one" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_wakeup" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_get_context" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_set_notify" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_add_fd" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_add_timeout" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_add_signal" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_del" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_del_by_fd" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_del_by_callback" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_del_by_context" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_task_del_by_all" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_set_listen_fd" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_get_fd_events" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + "silc_schedule_unset_listen_fd" "/home/priikone/silc1/doc/toolkit/silcschedule.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcschedule_i.html b/docs/toolkit/manual/silcschedule_i.html new file mode 100644 index 0000000..6a6b79d --- /dev/null +++ b/docs/toolkit/manual/silcschedule_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcschedule_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcschedule_i.xref b/docs/toolkit/manual/silcschedule_i.xref new file mode 100644 index 0000000..ad918d9 --- /dev/null +++ b/docs/toolkit/manual/silcschedule_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcschedule_i.h" "/home/priikone/silc1/doc/toolkit/silcschedule_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcserver-SilcServer.html b/docs/toolkit/manual/silcserver-SilcServer.html new file mode 100644 index 0000000..24bb6f4 --- /dev/null +++ b/docs/toolkit/manual/silcserver-SilcServer.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcServer

    + + +NAME + +
    
+    typedef struct SilcServerStruct *SilcServer;
+
+
    +DESCRIPTION + +
    
+    This context is the actual SILC Server context and is allocated
+    by silc_server_alloc and given as argument to all silc_server_*
+    functions.  It is freed by the silc_server_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Server Library Interface
    +SilcServer
    +SilcServerRunning
    +SilcServerStop
    +silc_server_alloc
    +silc_server_free
    +silc_server_run(1)
    +silc_server_run
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver-SilcServerRunning.html b/docs/toolkit/manual/silcserver-SilcServerRunning.html new file mode 100644 index 0000000..7311e99 --- /dev/null +++ b/docs/toolkit/manual/silcserver-SilcServerRunning.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcServerRunning

    + + +SYNOPSIS + +
    
+    typedef void (*SilcServerRunning)(SilcServer server, SilcBool running,
+                                      void *context);
+
+
    +DESCRIPTION + +
    
+    Called to indicate that the server is up and running and ready to
+    accept new connection and create connections to remote router, if
+    any has been configured.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Server Library Interface
    +SilcServer
    +SilcServerRunning
    +SilcServerStop
    +silc_server_alloc
    +silc_server_free
    +silc_server_run(1)
    +silc_server_run
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver-SilcServerStop.html b/docs/toolkit/manual/silcserver-SilcServerStop.html new file mode 100644 index 0000000..1852561 --- /dev/null +++ b/docs/toolkit/manual/silcserver-SilcServerStop.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcServerStop

    + + +SYNOPSIS + +
    
+    typedef void (*SilcServerStop)(SilcServer server, void *context);
+
+
    +DESCRIPTION + +
    
+    Called to indicate that the server has stopped and can be freed now.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Server Library Interface
    +SilcServer
    +SilcServerRunning
    +SilcServerStop
    +silc_server_alloc
    +silc_server_free
    +silc_server_run(1)
    +silc_server_run
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver-silc_server_alloc.html b/docs/toolkit/manual/silcserver-silc_server_alloc.html new file mode 100644 index 0000000..8caa165 --- /dev/null +++ b/docs/toolkit/manual/silcserver-silc_server_alloc.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_alloc

    + + +SYNOPSIS + +
    
+    SilcServer silc_server_alloc(void *app_context, SilcServerParams params,
+                                 SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Allocates SILC server context and returns it.  Returns NULL if case
+    of error.  The `app_context' is application specific context and
+    can be retrieved from the server by using silc_server_get_context
+    function.  The `params' context contains the SILC server parameters
+    that application has gathered most likely from a configuration file
+    or similar source.  The `params' and everything inside are allocated
+    by the caller, but the server library will own it and free it.  It
+    may also modify its content.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Server Library Interface
    +SilcServer
    +SilcServerRunning
    +SilcServerStop
    +silc_server_alloc
    +silc_server_free
    +silc_server_run(1)
    +silc_server_run
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver-silc_server_free.html b/docs/toolkit/manual/silcserver-silc_server_free.html new file mode 100644 index 0000000..259cd3f --- /dev/null +++ b/docs/toolkit/manual/silcserver-silc_server_free.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_free

    + + +SYNOPSIS + +
    
+    void silc_server_free(SilcServer server);
+
+
    +DESCRIPTION + +
    
+    Free the server context and all allocated resources.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Server Library Interface
    +SilcServer
    +SilcServerRunning
    +SilcServerStop
    +silc_server_alloc
    +silc_server_free
    +silc_server_run(1)
    +silc_server_run
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver-silc_server_run(1).html b/docs/toolkit/manual/silcserver-silc_server_run(1).html new file mode 100644 index 0000000..4ddf7fe --- /dev/null +++ b/docs/toolkit/manual/silcserver-silc_server_run(1).html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_run(1)

    + + +SYNOPSIS + +
    
+    void silc_server_run(SilcServer server, SilcServerRunning running,
+                         void *running_context);
+
+
    +DESCRIPTION + +
    
+    Starts the SILC server.  This function returns immediately and the
+    SilcSchedule must be run after this functions returns or it must be
+    already running when this function is called.  The `running' callback
+    will be called once the server is up and running.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Server Library Interface
    +SilcServer
    +SilcServerRunning
    +SilcServerStop
    +silc_server_alloc
    +silc_server_free
    +silc_server_run(1)
    +silc_server_run
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver-silc_server_run.html b/docs/toolkit/manual/silcserver-silc_server_run.html new file mode 100644 index 0000000..b8a0f41 --- /dev/null +++ b/docs/toolkit/manual/silcserver-silc_server_run.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_run

    + + +SYNOPSIS + +
    
+    void silc_server_stop(SilcServer server, SilcServerStop stop_callback,
+                          void *stop_context);
+
+
    +DESCRIPTION + +
    
+    Stops the SILC server.  Stopping of the server is asynchronous and
+    once it has stopped the `stopped' callback will be called with the
+    `stop_context'.  Application should not exit without calling this
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Server Library Interface
    +SilcServer
    +SilcServerRunning
    +SilcServerStop
    +silc_server_alloc
    +silc_server_free
    +silc_server_run(1)
    +silc_server_run
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver.html b/docs/toolkit/manual/silcserver.html new file mode 100644 index 0000000..5c3c0c1 --- /dev/null +++ b/docs/toolkit/manual/silcserver.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcserver.html + + + + +
    + +Server Library Interface
    Header: silcserver.h

    + + +DESCRIPTION + +
    
+
+
  • SilcServer +
  • SilcServerRunning +
  • SilcServerStop +
  • silc_server_alloc +
  • silc_server_free +
  • silc_server_run(1) +
  • silc_server_run + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver.xref b/docs/toolkit/manual/silcserver.xref new file mode 100644 index 0000000..72a516d --- /dev/null +++ b/docs/toolkit/manual/silcserver.xref @@ -0,0 +1,14 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcserver.h" "/home/priikone/silc1/doc/toolkit/silcserver.html" 0 + "Server Library Interface" "/home/priikone/silc1/doc/toolkit/silcserver.html" 1 + "SilcServer" "/home/priikone/silc1/doc/toolkit/silcserver.html" 5 + "SilcServerRunning" "/home/priikone/silc1/doc/toolkit/silcserver.html" 4 + "SilcServerStop" "/home/priikone/silc1/doc/toolkit/silcserver.html" 4 + "silc_server_alloc" "/home/priikone/silc1/doc/toolkit/silcserver.html" 4 + "silc_server_free" "/home/priikone/silc1/doc/toolkit/silcserver.html" 4 + "silc_server_run(1)" "/home/priikone/silc1/doc/toolkit/silcserver.html" 4 + "silc_server_run" "/home/priikone/silc1/doc/toolkit/silcserver.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_admin.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_admin.html new file mode 100644 index 0000000..8719326 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_admin.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_admin

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_admin(SilcServerParams params,
+                                      SilcServerParamAdmin admin);
+
+
    +DESCRIPTION + +
    
+    Adds an server administrator to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_cipher.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_cipher.html new file mode 100644 index 0000000..83ec981 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_cipher.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_cipher

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_cipher(SilcServerParams params,
+                                       SilcServerParamCipher cipher);
+
+
    +DESCRIPTION + +
    
+    Adds a cipher to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_client.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_client.html new file mode 100644 index 0000000..c65b424 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_client.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_client

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_client(SilcServerParams params,
+                                       SilcServerParamClient client);
+
+
    +DESCRIPTION + +
    
+    Adds a client connection to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_connparam.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_connparam.html new file mode 100644 index 0000000..9224cea --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_connparam.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_connparam

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_connparam(SilcServerParams params,
+                                          SilcServerParamConnParams param);
+
+
    +DESCRIPTION + +
    
+    Adds a connection parameters to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_deny.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_deny.html new file mode 100644 index 0000000..fbca884 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_deny.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_deny

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_deny(SilcServerParams params,
+                                     SilcServerParamDeny deny);
+
+
    +DESCRIPTION + +
    
+    Adds a denied connection to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_hash.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_hash.html new file mode 100644 index 0000000..57f622d --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_hash.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_hash

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_hash(SilcServerParams params,
+                                     SilcServerParamHash hash);
+
+
    +DESCRIPTION + +
    
+    Adds a hash function to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_hmac.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_hmac.html new file mode 100644 index 0000000..158d597 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_hmac.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_hmac

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_hmac(SilcServerParams params,
+                                     SilcServerParamHmac hmac);
+
+
    +DESCRIPTION + +
    
+    Adds a HMAC to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_pkcs.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_pkcs.html new file mode 100644 index 0000000..9314231 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_pkcs.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_pkcs

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_pkcs(SilcServerParams params,
+                                     SilcServerParamPkcs pkcs);
+
+
    +DESCRIPTION + +
    
+    Adds a HMAC to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_router.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_router.html new file mode 100644 index 0000000..659b51d --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_router.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_router

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_router(SilcServerParams params,
+                                       SilcServerParamRouter router);
+
+
    +DESCRIPTION + +
    
+    Adds a router connection to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_add_server.html b/docs/toolkit/manual/silcserver_params-silc_server_params_add_server.html new file mode 100644 index 0000000..ee533d3 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_add_server.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_add_server

    + + +SYNOPSIS + +
    
+    void silc_server_params_add_server(SilcServerParams params,
+                                       SilcServerParamServer server);
+
+
    +DESCRIPTION + +
    
+    Adds a server connection to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_alloc.html b/docs/toolkit/manual/silcserver_params-silc_server_params_alloc.html new file mode 100644 index 0000000..e958048 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_alloc.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_alloc

    + + +SYNOPSIS + +
    
+    SilcServerParams silc_server_params_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates server parameters context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_free.html b/docs/toolkit/manual/silcserver_params-silc_server_params_free.html new file mode 100644 index 0000000..49e25d0 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_free.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_free

    + + +SYNOPSIS + +
    
+    void silc_server_params_free(SilcServerParams params);
+
+
    +DESCRIPTION + +
    
+    Frees server parameters and all allocated resources in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc(1).html b/docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc(1).html new file mode 100644 index 0000000..67145e8 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc(1).html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_serverinfo_alloc(1)

    + + +SYNOPSIS + +
    
+    SilcServerParamServerInfo silc_server_params_serverinfo_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates server information context.  This does not have to be freed
+    by the caller.  It is freed when the server parameters are freed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc.html b/docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc.html new file mode 100644 index 0000000..885aabb --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_serverinfo_alloc.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_serverinfo_alloc

    + + +SYNOPSIS + +
    
+    void
+    silc_server_params_serverinfo_add_iface(SilcServerParamServerInfo info,
+                                            SilcServerParamInterface iface);
+
+
    +DESCRIPTION + +
    
+    Adds interface to server information parameters.  The first added
+    interface is the primary interface.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params-silc_server_params_set_serverinfo.html b/docs/toolkit/manual/silcserver_params-silc_server_params_set_serverinfo.html new file mode 100644 index 0000000..ce2c727 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params-silc_server_params_set_serverinfo.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_server_params_set_serverinfo

    + + +SYNOPSIS + +
    
+    void
+    silc_server_params_set_serverinfo(SilcServerParams params,
+                                      SilcServerParamServerInfo
+                                                       server_info);
+
+
    +DESCRIPTION + +
    
+    Set server's information to server parameters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +silc_server_params_alloc
    +silc_server_params_free
    +silc_server_params_serverinfo_alloc(1)
    +silc_server_params_serverinfo_alloc
    +silc_server_params_set_serverinfo
    +silc_server_params_add_cipher
    +silc_server_params_add_hash
    +silc_server_params_add_hmac
    +silc_server_params_add_pkcs
    +silc_server_params_add_client
    +silc_server_params_add_server
    +silc_server_params_add_router
    +silc_server_params_add_connparam
    +silc_server_params_add_deny
    +silc_server_params_add_admin
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params.html b/docs/toolkit/manual/silcserver_params.html new file mode 100644 index 0000000..3a546a7 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params.html @@ -0,0 +1,232 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcserver_params.html + + + + +
    + +Function silc_server_params_alloc

    + + +SYNOPSIS + +
    
+    SilcServerParams silc_server_params_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates server parameters context.
+
+
  • silc_server_params_free +
  • silc_server_params_serverinfo_alloc(1) +
  • silc_server_params_serverinfo_alloc +
  • silc_server_params_set_serverinfo +
  • silc_server_params_add_cipher +
  • silc_server_params_add_hash +
  • silc_server_params_add_hmac +
  • silc_server_params_add_pkcs +
  • silc_server_params_add_client +
  • silc_server_params_add_server +
  • silc_server_params_add_router +
  • silc_server_params_add_connparam +
  • silc_server_params_add_deny +
  • silc_server_params_add_admin + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcserver_params.xref b/docs/toolkit/manual/silcserver_params.xref new file mode 100644 index 0000000..9b8fce2 --- /dev/null +++ b/docs/toolkit/manual/silcserver_params.xref @@ -0,0 +1,21 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcserver_params.h" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 0 + "silc_server_params_alloc" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_free" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_serverinfo_alloc(1)" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_serverinfo_alloc" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_set_serverinfo" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_cipher" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_hash" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_hmac" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_pkcs" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_client" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_server" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_router" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_connparam" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_deny" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + "silc_server_params_add_admin" "/home/priikone/silc1/doc/toolkit/silcserver_params.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcsftp-SilcSFTP.html b/docs/toolkit/manual/silcsftp-SilcSFTP.html new file mode 100644 index 0000000..21ab7ae --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTP.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSFTP

    + + +NAME + +
    
+    typedef struct SilcSFTPStruct *SilcSFTP;
+
+
    +DESCRIPTION + +
    
+    This context is the actual SFTP client and SFTP server, and is
+    allocated by silc_sftp_client_start or silc_sftp_server_start and
+    given as argument usually to all silc_sftp_* functions.  It is freed
+    by the silc_sftp_client_shutdown or silc_sftp_server_shutdown
+    functions.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPAttrCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPAttrCallback.html new file mode 100644 index 0000000..0eb4ab8 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPAttrCallback.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPAttrCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPAttrCallback)(SilcSFTP sftp,
+                                         SilcSFTPStatus status,
+                                         const SilcSFTPAttributes attrs,
+                                         void *context);
+
+
    +DESCRIPTION + +
    
+    Attributes callback is called when the server returns the attributes
+    for a file the client has requested.  The attributes are saved in
+    the `attrs' structure.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPAttributes.html b/docs/toolkit/manual/silcsftp-SilcSFTPAttributes.html new file mode 100644 index 0000000..0022fcd --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPAttributes.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSFTPAttributes

    + + +NAME + +
    
+    typedef struct { ... } *SilcSFTPAttributes, SilcSFTPAttributesStruct;
+
+
    +DESCRIPTION + +
    
+    SFTP File attributes structure represents the attributes for a file.
+    This structure can be used by the client to send attributes to the
+    server, and by server to return file attributes to the client.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPDataCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPDataCallback.html new file mode 100644 index 0000000..b8cc352 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPDataCallback.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPDataCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPDataCallback)(SilcSFTP sftp,
+                                         SilcSFTPStatus status,
+                                         const unsigned char *data,
+                                         SilcUInt32 data_len,
+                                         void *context);
+
+
    +DESCRIPTION + +
    
+    Data callback is called when data packet is received from the server.
+    This is called for example when application is reading a file from
+    the server.  The `data' is the raw data of length of `data_len'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPErrorCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPErrorCallback.html new file mode 100644 index 0000000..35d500d --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPErrorCallback.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPErrorCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPErrorCallback)(SilcSFTP sftp,
+                                          SilcSFTPStatus status,
+                                          void *context);
+
+
    +DESCRIPTION + +
    
+    Error callback is called if a connection error occurs during SFTP
+    session.  If the connection or stream is closed this callback is
+    called.  Other errors are delivered in other callbacks.  Only the
+    SILC_SFTP_STATUS_EOF or SILC_SFTP_STATUS_NO_CONNECTION is delivered
+    in this callback.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPExtendedCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPExtendedCallback.html new file mode 100644 index 0000000..1634a7b --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPExtendedCallback.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPExtendedCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPExtendedCallback)(SilcSFTP sftp,
+                                             SilcSFTPStatus status,
+                                             const unsigned char *data,
+                                             SilcUInt32 data_len,
+                                             void *context);
+
+
    +DESCRIPTION + +
    
+    Extended request callback is called when client sends extended
+    request to the server. The `data' is arbitrary data returned by the
+    server and its encoding is the extended request specific.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPFileOperation.html b/docs/toolkit/manual/silcsftp-SilcSFTPFileOperation.html new file mode 100644 index 0000000..9980ead --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPFileOperation.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSFTPFileOperation

    + + +NAME + +
    
+    typedef enum { ... } SilcSFTPFileOperation
+
+
    +DESCRIPTION + +
    
+    SFTP protocol file operation flags.  These enumerations can be used
+    by the client when client is opening an file, to indicate how it
+    would like to open the file.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SFTP_FXF_READ           = 0x00000001, /* Reading */
+      SILC_SFTP_FXF_WRITE          = 0x00000002, /* Writing */
+      SILC_SFTP_FXF_APPEND         = 0x00000004, /* Appending to end of file */
+      SILC_SFTP_FXF_CREAT          = 0x00000008, /* Create if doesn't exist */
+      SILC_SFTP_FXF_TRUNC          = 0x00000010, /* Truncate if exists */
+      SILC_SFTP_FXF_EXCL           = 0x00000020, /* Don't create if exists */
+    } SilcSFTPFileOperation;
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPHandle.html b/docs/toolkit/manual/silcsftp-SilcSFTPHandle.html new file mode 100644 index 0000000..5fe483d --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPHandle.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSFTPHandle

    + + +NAME + +
    
+    typedef struct SilcSFTPHandleStruct *SilcSFTPHandle;
+
+
    +DESCRIPTION + +
    
+    This context represents an open file handle and is allocated by
+    the library.  The application receives this context in the
+    SilcSFTPHandleCallback function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPHandleCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPHandleCallback.html new file mode 100644 index 0000000..ec4f71d --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPHandleCallback.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPHandleCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPHandleCallback)(SilcSFTP sftp,
+                                           SilcSFTPStatus status,
+                                           SilcSFTPHandle handle,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    Handle callback is called when the server returns a handle to the
+    client as a result of some request client has made.  The `handle'
+    is the file handle and the application can use it to perform file
+    operations for the handle. Each of the returned handle must be
+    also closed at some point with silc_sftp_close.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPMonitor.html b/docs/toolkit/manual/silcsftp-SilcSFTPMonitor.html new file mode 100644 index 0000000..3e2ad9a --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPMonitor.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPMonitor

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPMonitor)(SilcSFTP sftp
+                                    SilcSFTPMonitors type,
+                                    const SilcSFTPMonitorData data,
+                                    void *context);
+
+
    +DESCRIPTION + +
    
+    Monitor callback that is called when an specified request is
+    received from client.  The `type' is the requested type that
+    was being monitored.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPMonitorData.html b/docs/toolkit/manual/silcsftp-SilcSFTPMonitorData.html new file mode 100644 index 0000000..984ae18 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPMonitorData.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSFTPMonitorData

    + + +NAME + +
    
+    typedef struct { ... } *SilcSFTPMonitorData, SilcSFTPMonitorDataStruct;
+
+
    +DESCRIPTION + +
    
+    This structure includes the monitor type specific data.  The
+    application can check what the client has requested from this
+    structure.  See the comments below what data is available for what
+    monitor type.
+
+
    +SOURCE + +
        typedef struct SilcSFTPMonitorDataObject {
+      SilcSFTPVersion version;      /* _INIT */
+      char *name;                   /* _OPEN, _REMOVE, _RENAME, _MKDIR,
+                                       _RMDIR, _OPENDIR, _STAT, _LSTAT,
+                                       _SETSTAT, _READLINK, _SYMLINK, _REALPATH */
+      char *name2;                  /* _RENAME, _SYMLINK */
+      SilcSFTPFileOperation pflags; /* _OPEN */
+      SilcUInt64 offset;            /* _READ, _WRITE */
+      SilcUInt32 data_len;          /* _READ, _WRITE */
+      SilcSFTPName names;           /* _READDIR, _READLINK, _REALPATH */
+    } *SilcSFTPMonitorData, SilcSFTPMonitorDataStruct;
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPMonitors.html b/docs/toolkit/manual/silcsftp-SilcSFTPMonitors.html new file mode 100644 index 0000000..a7c30bf --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPMonitors.html @@ -0,0 +1,278 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSFTPMonitors

    + + +NAME + +
    
+    typedef enum { ... } SilcSFTPMonitors;
+
+
    +DESCRIPTION + +
    
+    SFTP server monitor types. These can be masked together to monitor
+    various client requests.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SFTP_MONITOR_INIT        = 0x0001,
+      SILC_SFTP_MONITOR_OPEN        = 0x0002,
+      SILC_SFTP_MONITOR_CLOSE       = 0x0004,
+      SILC_SFTP_MONITOR_READ        = 0x0008,
+      SILC_SFTP_MONITOR_WRITE       = 0x0010,
+      SILC_SFTP_MONITOR_REMOVE      = 0x0020,
+      SILC_SFTP_MONITOR_RENAME      = 0x0040,
+      SILC_SFTP_MONITOR_MKDIR       = 0x0080,
+      SILC_SFTP_MONITOR_RMDIR       = 0x0100,
+      SILC_SFTP_MONITOR_OPENDIR     = 0x0200,
+      SILC_SFTP_MONITOR_READDIR     = 0x0400,
+      SILC_SFTP_MONITOR_STAT        = 0x0800,
+      SILC_SFTP_MONITOR_LSTAT       = 0x1000,
+      SILC_SFTP_MONITOR_FSTAT       = 0x2000,
+      SILC_SFTP_MONITOR_SETSTAT     = 0x4000,
+      SILC_SFTP_MONITOR_FSETSTAT    = 0x8000,
+      SILC_SFTP_MONITOR_READLINK    = 0x10000,
+      SILC_SFTP_MONITOR_SYMLINK     = 0x20000,
+      SILC_SFTP_MONITOR_REALPATH    = 0x40000,
+      SILC_SFTP_MONITOR_EXTENDED    = 0x80000,
+    } SilcSFTPMonitors;
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPName.html b/docs/toolkit/manual/silcsftp-SilcSFTPName.html new file mode 100644 index 0000000..49fc6ff --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPName.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSFTPName

    + + +NAME + +
    
+    typedef struct { ... } *SilcSFTPName, SilcSFTPNameStruct
+
+
    +DESCRIPTION + +
    
+    SFTP Name structure represents the name reply received from the server.
+    It includes the returned file(s) short and long file names and
+    attributes for the file(s).  This is returned by the server for
+    example when reading the contents of a directory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPNameCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPNameCallback.html new file mode 100644 index 0000000..39962b8 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPNameCallback.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPNameCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPNameCallback)(SilcSFTP sftp,
+                                         SilcSFTPStatus status,
+                                         const SilcSFTPName name,
+                                         void *context);
+
+
    +DESCRIPTION + +
    
+    Name callback is called when directory is being read by the client.
+    The server returns one or more file names in one reply.  These file
+    names are saved in the `filename' structures with their short and
+    long name format, and with file attributes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPStatus.html b/docs/toolkit/manual/silcsftp-SilcSFTPStatus.html new file mode 100644 index 0000000..fc74a6f --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPStatus.html @@ -0,0 +1,288 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSFTPStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcSFTPStatus
+
+
    +DESCRIPTION + +
    
+    SFTP protocol status types.  These enumerations is used to indicate
+    the status of request.  The server can send these to the client when
+    client has requested an operation.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SFTP_STATUS_OK                  = 0,  /* Operation successful */
+      SILC_SFTP_STATUS_EOF                 = 1,  /* No more data available */
+      SILC_SFTP_STATUS_NO_SUCH_FILE        = 2,  /* File does not exist */
+      SILC_SFTP_STATUS_PERMISSION_DENIED   = 3,  /* No sufficient permissions */
+      SILC_SFTP_STATUS_FAILURE             = 4,  /* Operation failed */
+      SILC_SFTP_STATUS_BAD_MESSAGE         = 5,  /* Bad message received */
+      SILC_SFTP_STATUS_NO_CONNECTION       = 6,  /* No connection to remote */
+      SILC_SFTP_STATUS_CONNECTION_LOST     = 7,  /* Connection lost to server */
+      SILC_SFTP_STATUS_OP_UNSUPPORTED      = 8,  /* Operation unsupported */
+      SILC_SFTP_STATUS_INVALID_HANDLE      = 9,  /* Invalid file handle */
+      SILC_SFTP_STATUS_NO_SUCH_PATH        = 10, /* Path does not exist */
+      SILC_SFTP_STATUS_FILE_ALREADY_EXIST  = 11, /* File already exists */
+      SILC_SFTP_STATUS_WRITE_PROTECT       = 12, /* Read-only or protected */
+      SILC_SFTP_STATUS_NO_MEDIA            = 13, /* No media available */
+      SILC_SFTP_STATUS_NO_SPACE_ON_DEVICE  = 14, /* No space on device */
+      SILC_SFTP_STATUS_QUOTA_EXCEEDED      = 15, /* Quota limit reached */
+      SILC_SFTP_STATUS_UNKNOWN_PRINCIBLE   = 16, /* Unknown princible */
+      SILC_SFTP_STATUS_LOCK_CONFLICT       = 17, /* File already locked */
+      SILC_SFTP_STATUS_NOT_EMPTY           = 18, /* Directory not empty */
+      SILC_SFTP_STATUS_NOT_A_DIRECTORY     = 19, /* Not a directory */
+      SILC_SFTP_STATUS_INVALID_FILENAME    = 20, /* Invalid filename */
+      SILC_SFTP_STATUS_LINK_LOOP           = 21, /* Too many symlinks */
+      SILC_SFTP_STATUS_CANNOT_DELETE       = 22, /* Could not delete file */
+      SILC_SFTP_STATUS_INVALID_PARAMETER   = 23, /* Invalid parameter */
+      SILC_SFTP_STATUS_FILE_IS_A_DIRECTORY = 24, /* File is a directory file */
+      SILC_SFTP_STATUS_BR_LOCK_CONFLICT    = 25, /* Byte range lock conflict */
+      SILC_SFTP_STATUS_BR_LOCK_REFUSED     = 26, /* Byte range lock refused */
+      SILC_SFTP_STATUS_DELETE_PENDING      = 27, /* File is being deleted */
+      SILC_SFTP_STATUS_FILE_CORRUPT        = 28, /* File is corrupted */
+    } SilcSFTPStatus;
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPStatusCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPStatusCallback.html new file mode 100644 index 0000000..97838c0 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPStatusCallback.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPStatusCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPStatusCallback)(SilcSFTP sftp,
+                                           SilcSFTPStatus status,
+                                           const char *message,
+                                           const char *language_tag,
+                                           void *context);
+
+
    +DESCRIPTION + +
    
+    Status callback is called every time server returns a status packet
+    for a request the client has made. The `status' indicates the type
+    of the status.  The `message' is optional error message received from
+    the server, in language indicated by the `language_tag'.  Both of
+    these pointers may be NULL.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPVersion.html b/docs/toolkit/manual/silcsftp-SilcSFTPVersion.html new file mode 100644 index 0000000..4447928 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPVersion.html @@ -0,0 +1,253 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSFTPVersion

    + + +NAME + +
    
+    typedef SilcUInt32 SilcSFTPVersion;
+
+
    +DESCRIPTION + +
    
+    SFTP Version type.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-SilcSFTPVersionCallback.html b/docs/toolkit/manual/silcsftp-SilcSFTPVersionCallback.html new file mode 100644 index 0000000..be2b341 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-SilcSFTPVersionCallback.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSFTPVersionCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSFTPVersionCallback)(SilcSFTP sftp,
+                                            SilcSFTPStatus status,
+                                            SilcSFTPVersion version,
+                                            void *context);
+
+
    +DESCRIPTION + +
    
+    Version callback is called at the protocol initialization phase when
+    the server returns the version of the protocol. The `version' indicates
+    the version of the protocol.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_client_shutdown.html b/docs/toolkit/manual/silcsftp-silc_sftp_client_shutdown.html new file mode 100644 index 0000000..80dbe4d --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_client_shutdown.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_client_shutdown

    + + +SYNOPSIS + +
    
+    void silc_sftp_client_shutdown(SilcSFTP sftp);
+
+
    +DESCRIPTION + +
    
+    Shutdown's the SFTP client.  The caller is responsible of closing
+    the associated stream.  The SFTP context is freed and is invalid after
+    this function returns.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_client_start.html b/docs/toolkit/manual/silcsftp-silc_sftp_client_start.html new file mode 100644 index 0000000..83e21ae --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_client_start.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_client_start

    + + +SYNOPSIS + +
    
+    SilcSFTP silc_sftp_client_start(SilcStream stream,
+                                    SilcSchedule schedule,
+                                    SilcSFTPVersionCallback version_cb,
+                                    SilcSFTPErrorCallback error_cb,
+                                    void *context);
+
+
    +DESCRIPTION + +
    
+    Starts SFTP client and returns context to it.  The version callback
+    indicated by the `version_cb' will be called after the SFTP session has
+    been started and server has returned the version of the protocol.  The
+    SFTP client context is returned in the callback too.  This returns the
+    allocated SFTP client context or NULL on error.  The `stream' will be
+    used to read and write the SFTP packets.  The `error_cb' will be called
+    in case a stream error occurs, such as end of stream.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_close.html b/docs/toolkit/manual/silcsftp-silc_sftp_close.html new file mode 100644 index 0000000..ef84596 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_close.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_close

    + + +SYNOPSIS + +
    
+    void silc_sftp_close(SilcSFTP sftp,
+                         SilcSFTPHandle handle,
+                         SilcSFTPStatusCallback callback,
+                         void *context);
+
+
    +DESCRIPTION + +
    
+    Closes the file indicated by the file handle `handle'.  Calls the
+    `callback' to indicate the status of the closing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_extended.html b/docs/toolkit/manual/silcsftp-silc_sftp_extended.html new file mode 100644 index 0000000..62bd6a8 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_extended.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_extended

    + + +SYNOPSIS + +
    
+    void silc_sftp_extended(SilcSFTP sftp,
+                            const char *request,
+                            const unsigned char *data,
+                            SilcUInt32 data_len,
+                            SilcSFTPExtendedCallback callback,
+                            void *context);
+
+
    +DESCRIPTION + +
    
+    Performs an extended operation indicated by the `request' with
+    optional extended operation data indicated by the `data'.  The callback
+    is called to return any data associated with the extended request.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_fsetstat.html b/docs/toolkit/manual/silcsftp-silc_sftp_fsetstat.html new file mode 100644 index 0000000..3f64554 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_fsetstat.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fsetstat

    + + +SYNOPSIS + +
    
+    void silc_sftp_fsetstat(SilcSFTP sftp,
+                            SilcSFTPHandle handle,
+                            SilcSFTPAttributes attrs,
+                            SilcSFTPStatusCallback callback,
+                            void *context);
+
+
    +DESCRIPTION + +
    
+    Sets a file attributes to a opened file indicated by the `handle' with
+    the attributes indicated by the `attrs'.  Calls the `callback' to
+    indicate the status of the setting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_fstat.html b/docs/toolkit/manual/silcsftp-silc_sftp_fstat.html new file mode 100644 index 0000000..9a206e9 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_fstat.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fstat

    + + +SYNOPSIS + +
    
+    void silc_sftp_fstat(SilcSFTP fstp,
+                         SilcSFTPHandle handle,
+                         SilcSFTPAttrCallback callback,
+                         void *context);
+
+
    +DESCRIPTION + +
    
+    Gets a file attributes for a opened file indicated by the `handle'.
+    Calls the `callback' to return the file attributes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_lstat.html b/docs/toolkit/manual/silcsftp-silc_sftp_lstat.html new file mode 100644 index 0000000..ef5ecf4 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_lstat.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_lstat

    + + +SYNOPSIS + +
    
+    void silc_sftp_lstat(SilcSFTP sftp,
+                         const char *path,
+                         SilcSFTPAttrCallback callback,
+                         void *context);
+
+
    +DESCRIPTION + +
    
+    Gets the file attributes for a file indicated by the `path'. This
+    will not follow symbolic links. Calls the `callback' to return the
+    file attributes
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_mkdir.html b/docs/toolkit/manual/silcsftp-silc_sftp_mkdir.html new file mode 100644 index 0000000..c5ca30b --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_mkdir.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_mkdir

    + + +SYNOPSIS + +
    
+    void silc_sftp_mkdir(SilcSFTP sftp,
+                         const char *path,
+                         SilcSFTPAttributes attrs,
+                         SilcSFTPStatusCallback callback,
+                         void *context);
+
+
    +DESCRIPTION + +
    
+    Creates a new directory indicated by the `path' with attributes indicated
+    by the `attrs'. The `callback' is called to indicate the status of the
+    creation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_open.html b/docs/toolkit/manual/silcsftp-silc_sftp_open.html new file mode 100644 index 0000000..0b718c5 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_open.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_open

    + + +SYNOPSIS + +
    
+    void silc_sftp_open(SilcSFTP sftp,
+                        const char *filename,
+                        SilcSFTPFileOperation pflags,
+                        SilcSFTPAttributes attrs,
+                        SilcSFTPHandleCallback callback,
+                        void *context);
+
+
    +DESCRIPTION + +
    
+    Open a file indicated by the `filename' with flags indicated by the
+    `pflags', and with attributes indicated by the `attsr'.  Calls the
+    `callback' to return the opened file handle.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_opendir.html b/docs/toolkit/manual/silcsftp-silc_sftp_opendir.html new file mode 100644 index 0000000..3d2b7f2 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_opendir.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_opendir

    + + +SYNOPSIS + +
    
+    void silc_sftp_opendir(SilcSFTP sftp,
+                           const char *path,
+                           SilcSFTPHandleCallback callback,
+                           void *context);
+
+
    +DESCRIPTION + +
    
+    Opens a directory indicated by the `path'.  The `callback' is called
+    to return the opened file handle.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_read.html b/docs/toolkit/manual/silcsftp-silc_sftp_read.html new file mode 100644 index 0000000..5af8eaa --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_read.html @@ -0,0 +1,260 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_read

    + + +SYNOPSIS + +
    
+    void silc_sftp_read(SilcSFTP sftp,
+                        SilcSFTPHandle handle,
+                        SilcUInt64 offset,
+                        SilcUInt32 len,
+                        SilcSFTPDataCallback callback,
+                        void *context);
+
+
    +DESCRIPTION + +
    
+    Reads data from the file indicated by the file handle `handle' starting
+    from the offset of `offset' at most `len' bytes.  The `callback' is
+    called to return the read data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_readdir.html b/docs/toolkit/manual/silcsftp-silc_sftp_readdir.html new file mode 100644 index 0000000..f775e81 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_readdir.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_readdir

    + + +SYNOPSIS + +
    
+    void silc_sftp_readdir(SilcSFTP sftp,
+                           SilcSFTPHandle handle,
+                           SilcSFTPNameCallback callback,
+                           void *context);
+
+
    +DESCRIPTION + +
    
+    Reads the contents of the directory indicated by the `handle' and
+    calls the `callback' to return the read file(s) from the directory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_readlink.html b/docs/toolkit/manual/silcsftp-silc_sftp_readlink.html new file mode 100644 index 0000000..f9a2f3f --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_readlink.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_readlink

    + + +SYNOPSIS + +
    
+    void silc_sftp_readlink(SilcSFTP sftp,
+                            const char *path,
+                            SilcSFTPNameCallback callback,
+                            void *context);
+
+
    +DESCRIPTION + +
    
+    Reads the target of a symbolic link indicated by the `path'.  The
+    `callback' is called to return the target of the symbolic link.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_realpath.html b/docs/toolkit/manual/silcsftp-silc_sftp_realpath.html new file mode 100644 index 0000000..b6db6cc --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_realpath.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_realpath

    + + +SYNOPSIS + +
    
+    void silc_sftp_realpath(SilcSFTP sftp,
+                            const char *path,
+                            SilcSFTPNameCallback callback,
+                            void *context);
+
+
    +DESCRIPTION + +
    
+    Canonicalizes the path indicated by the `path' to a absolute path.
+    The `callback' is called to return the absolute path.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_remove.html b/docs/toolkit/manual/silcsftp-silc_sftp_remove.html new file mode 100644 index 0000000..2f32172 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_remove.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_remove

    + + +SYNOPSIS + +
    
+    void silc_sftp_remove(SilcSFTP sftp,
+                          const char *filename,
+                          SilcSFTPStatusCallback callback,
+                          void *context);
+
+
    +DESCRIPTION + +
    
+    Removes a file indicated by the `filename'.  Calls the `callback'
+    to indicate the status of the removing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_rename.html b/docs/toolkit/manual/silcsftp-silc_sftp_rename.html new file mode 100644 index 0000000..fb27468 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_rename.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_rename

    + + +SYNOPSIS + +
    
+    void silc_sftp_rename(SilcSFTP sftp,
+                          const char *oldname,
+                          const char *newname,
+                          SilcSFTPStatusCallback callback,
+                          void *context);
+
+
    +DESCRIPTION + +
    
+    Renames a file indicated by the `oldname' to the name `newname'.  The
+    `callback' is called to indicate the status of the renaming.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_rmdir.html b/docs/toolkit/manual/silcsftp-silc_sftp_rmdir.html new file mode 100644 index 0000000..aa89259 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_rmdir.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_rmdir

    + + +SYNOPSIS + +
    
+    void silc_sftp_rmdir(SilcSFTP sftp,
+                         const char *path,
+                         SilcSFTPStatusCallback callback,
+                         void *context);
+
+
    +DESCRIPTION + +
    
+    Removes a directory indicated by the `path' and calls the `callback'
+    to indicate the status of the removal.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_server_set_monitor.html b/docs/toolkit/manual/silcsftp-silc_sftp_server_set_monitor.html new file mode 100644 index 0000000..99ac7b0 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_server_set_monitor.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_server_set_monitor

    + + +SYNOPSIS + +
    
+    void silc_sftp_server_set_monitor(SilcSFTP sftp,
+                                      SilcSFTPMonitors monitors,
+                                      SilcSFTPMonitor monitor,
+                                      void *context);
+
+
    +DESCRIPTION + +
    
+    Sets monitor callback to monitor various request sent by a client.
+    When request that has been set in the `monitors' is received the
+    monitor callback will be called to notify the caller.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_server_shutdown.html b/docs/toolkit/manual/silcsftp-silc_sftp_server_shutdown.html new file mode 100644 index 0000000..1a66894 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_server_shutdown.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_server_shutdown

    + + +SYNOPSIS + +
    
+    void silc_sftp_server_shutdown(SilcSFTP sftp);
+
+
    +DESCRIPTION + +
    
+    Shutdown the SFTP server.  The caller is responsible of closing the
+    associated stream.  The SFTP context is freed and is invalid after
+    this function returns.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_server_start.html b/docs/toolkit/manual/silcsftp-silc_sftp_server_start.html new file mode 100644 index 0000000..52ff568 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_server_start.html @@ -0,0 +1,262 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_server_start

    + + +SYNOPSIS + +
    
+    SilcSFTP silc_sftp_server_start(SilcStream stream,
+                                    SilcSchedule schedule,
+                                    SilcSFTPErrorCallback error_cb,
+                                    void *context,
+                                    SilcSFTPFilesystem fs);
+
+
    +DESCRIPTION + +
    
+    Starts SFTP server and returns a context to it.  This function returns
+    the allocated SFTP server context or NULL on error.  The `stream' is
+    the stream (connection) to the client.  The `error_cb' will be called
+    when the `stream' is ended (SILC_SFTP_STATUS_EOF).  The caller is
+    responsible of closing and destroying the `stream'.  The `fs' is the
+    filesystem context allocated by the application.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_setstat.html b/docs/toolkit/manual/silcsftp-silc_sftp_setstat.html new file mode 100644 index 0000000..af99b4d --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_setstat.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_setstat

    + + +SYNOPSIS + +
    
+    void silc_sftp_setstat(SilcSFTP sftp,
+                           const char *path,
+                           SilcSFTPAttributes attrs,
+                           SilcSFTPStatusCallback callback,
+                           void *context);
+
+
    +DESCRIPTION + +
    
+    Sets a file attributes to a file indicated by the `path' with the
+    attributes indicated by the `attrs'.  Calls the `callback' to indicate
+    the status of the setting.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_stat.html b/docs/toolkit/manual/silcsftp-silc_sftp_stat.html new file mode 100644 index 0000000..d676ce8 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_stat.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_stat

    + + +SYNOPSIS + +
    
+    void silc_sftp_stat(SilcSFTP sftp,
+                        const char *path,
+                        SilcSFTPAttrCallback callback,
+                        void *context);
+
+
    +DESCRIPTION + +
    
+    Gets the file attributes for a file indicated by the `path'. This
+    will follow symbolic links also. Calls the `callback' to return the
+    file attributes.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_symlink.html b/docs/toolkit/manual/silcsftp-silc_sftp_symlink.html new file mode 100644 index 0000000..5d26889 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_symlink.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_symlink

    + + +SYNOPSIS + +
    
+    void silc_sftp_symlink(SilcSFTP sftp,
+                           const char *linkpath,
+                           const char *targetpath,
+                           SilcSFTPStatusCallback callback,
+                           void *context);
+
+
    +DESCRIPTION + +
    
+    Creates a new symbolic link indicated by the `linkpath' to the target
+    indicated by the `targetpath'.  The `callback' is called to indicate
+    the status of creation.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp-silc_sftp_write.html b/docs/toolkit/manual/silcsftp-silc_sftp_write.html new file mode 100644 index 0000000..6548189 --- /dev/null +++ b/docs/toolkit/manual/silcsftp-silc_sftp_write.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_write

    + + +SYNOPSIS + +
    
+    void silc_sftp_write(SilcSFTP sftp,
+                         SilcSFTPHandle handle,
+                         SilcUInt64 offset,
+                         const unsigned char *data,
+                         SilcUInt32 data_len,
+                         SilcSFTPStatusCallback callback,
+                         void *context);
+
+
    +DESCRIPTION + +
    
+    Writes to a file indicated by the file handle `handle' starting from
+    offset of `offset' at most `data_len' bytes of `data'.  The `callback'
+    is called to indicate the status of the writing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SFTP Interface
    +SilcSFTP
    +SilcSFTPVersion
    +SilcSFTPStatus
    +SilcSFTPFileOperation
    +SilcSFTPAttributes
    +SilcSFTPName
    +SilcSFTPHandle
    +SilcSFTPVersionCallback
    +SilcSFTPErrorCallback
    +SilcSFTPStatusCallback
    +SilcSFTPHandleCallback
    +SilcSFTPDataCallback
    +SilcSFTPNameCallback
    +SilcSFTPAttrCallback
    +SilcSFTPExtendedCallback
    +silc_sftp_client_start
    +silc_sftp_client_shutdown
    +silc_sftp_open
    +silc_sftp_close
    +silc_sftp_read
    +silc_sftp_write
    +silc_sftp_remove
    +silc_sftp_rename
    +silc_sftp_mkdir
    +silc_sftp_rmdir
    +silc_sftp_opendir
    +silc_sftp_readdir
    +silc_sftp_stat
    +silc_sftp_lstat
    +silc_sftp_fstat
    +silc_sftp_setstat
    +silc_sftp_fsetstat
    +silc_sftp_readlink
    +silc_sftp_symlink
    +silc_sftp_realpath
    +silc_sftp_extended
    +silc_sftp_server_start
    +silc_sftp_server_shutdown
    +SilcSFTPMonitors
    +SilcSFTPMonitorData
    +SilcSFTPMonitor
    +silc_sftp_server_set_monitor
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp.html b/docs/toolkit/manual/silcsftp.html new file mode 100644 index 0000000..76f9865 --- /dev/null +++ b/docs/toolkit/manual/silcsftp.html @@ -0,0 +1,267 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsftp.html + + + + +
    + +SILC SFTP Interface
    Header: silcsftp.h

    + + +DESCRIPTION + +
    
+ SILC SFTP Interface is the implementation of the Secure File Transfer
+ Protocol (or SSH File Transfer Protocol).  The interface defines the SFTP
+ client and the SFTP server.  The SFTP is the mandatory file transfer
+ protocol in the SILC protocol, and when used in SILC the SFTP packets are
+ encapsulated into SILC packets.  The SFTP server implementation is
+ filesystem independent and generic interface is defined to represent
+ filesystem access.
+
+ The SilcSFTP context is the actual SFTP client or SFTP server, and each
+ SFTP session should create its own SFTP context.
+
+ The SILC SFTP library is a generic SFTP implementation and not directly
+ related to either SILC or SSH.  It could be used for any general purpose
+ SFTP application.
+
+
  • SilcSFTP +
  • SilcSFTPVersion +
  • SilcSFTPStatus +
  • SilcSFTPFileOperation +
  • SilcSFTPAttributes +
  • SilcSFTPName +
  • SilcSFTPHandle +
  • SilcSFTPVersionCallback +
  • SilcSFTPErrorCallback +
  • SilcSFTPStatusCallback +
  • SilcSFTPHandleCallback +
  • SilcSFTPDataCallback +
  • SilcSFTPNameCallback +
  • SilcSFTPAttrCallback +
  • SilcSFTPExtendedCallback +
  • silc_sftp_client_start +
  • silc_sftp_client_shutdown +
  • silc_sftp_open +
  • silc_sftp_close +
  • silc_sftp_read +
  • silc_sftp_write +
  • silc_sftp_remove +
  • silc_sftp_rename +
  • silc_sftp_mkdir +
  • silc_sftp_rmdir +
  • silc_sftp_opendir +
  • silc_sftp_readdir +
  • silc_sftp_stat +
  • silc_sftp_lstat +
  • silc_sftp_fstat +
  • silc_sftp_setstat +
  • silc_sftp_fsetstat +
  • silc_sftp_readlink +
  • silc_sftp_symlink +
  • silc_sftp_realpath +
  • silc_sftp_extended +
  • silc_sftp_server_start +
  • silc_sftp_server_shutdown +
  • SilcSFTPMonitors +
  • SilcSFTPMonitorData +
  • SilcSFTPMonitor +
  • silc_sftp_server_set_monitor + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp.xref b/docs/toolkit/manual/silcsftp.xref new file mode 100644 index 0000000..9539226 --- /dev/null +++ b/docs/toolkit/manual/silcsftp.xref @@ -0,0 +1,49 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsftp.h" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 0 + "SILC SFTP Interface" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 1 + "SilcSFTP" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 5 + "SilcSFTPVersion" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 8 + "SilcSFTPStatus" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 8 + "SilcSFTPFileOperation" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 8 + "SilcSFTPAttributes" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 5 + "SilcSFTPName" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 5 + "SilcSFTPHandle" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 5 + "SilcSFTPVersionCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPErrorCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPStatusCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPHandleCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPDataCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPNameCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPAttrCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPExtendedCallback" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_client_start" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_client_shutdown" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_open" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_close" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_read" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_write" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_remove" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_rename" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_mkdir" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_rmdir" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_opendir" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_readdir" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_stat" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_lstat" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_fstat" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_setstat" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_fsetstat" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_readlink" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_symlink" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_realpath" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_extended" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_server_start" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_server_shutdown" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "SilcSFTPMonitors" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 8 + "SilcSFTPMonitorData" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 5 + "SilcSFTPMonitor" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + "silc_sftp_server_set_monitor" "/home/priikone/silc1/doc/toolkit/silcsftp.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcsftp_fs-SilcSFTPFSMemoryPerm.html b/docs/toolkit/manual/silcsftp_fs-SilcSFTPFSMemoryPerm.html new file mode 100644 index 0000000..eb043e5 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-SilcSFTPFSMemoryPerm.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSFTPFSMemoryPerm

    + + +NAME + +
    
+    typedef enum { ... } SilcSFTPFSMemoryPerm;
+
+
    +DESCRIPTION + +
    
+    Memory filesystem permission definition.  These enumerations can
+    be used to set the permission mask for directories and files.
+    The permissions behave in POSIX style.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SFTP_FS_PERM_READ    = 0x0001,    /* Reading allowed */
+      SILC_SFTP_FS_PERM_WRITE   = 0x0002,    /* Writing allowed */
+      SILC_SFTP_FS_PERM_EXEC    = 0x0004,    /* Execution allowed */
+    } SilcSFTPFSMemoryPerm;
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystem.html b/docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystem.html new file mode 100644 index 0000000..908ce0e --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystem.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSFTPFilesystem

    + + +NAME + +
    
+    typedef struct { ... } *SilcSFTPFilesystem;
+
+
    +DESCRIPTION + +
    
+    This context is allocated and returned by all filesystem allocation
+    routines.  The returned context is given as argument to the
+    silc_sftp_server_start function.  The caller must also free the
+    context after the SFTP server is shutdown.
+
+
    +SOURCE + +
        typedef struct SilcSFTPFilesystemStruct {
+      SilcSFTPFilesystemOps fs;
+      void *fs_context;
+    } *SilcSFTPFilesystem;
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystemOps.html b/docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystemOps.html new file mode 100644 index 0000000..fb6b168 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-SilcSFTPFilesystemOps.html @@ -0,0 +1,397 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSFTPFilesystemOps

    + + +NAME + +
    
+    typedef struct SilcSFTPFilesystemOpsStruct { ... }
+                     *SilcSFTPFilesystemOps;
+
+
    +DESCRIPTION + +
    
+    This structure defines the generic filesystem access.  When the
+    filesystem is accessed these functions are called to do the requested
+    filesystem operation.  The level that implements the actual filesystem
+    must fill this structure with the callback functions providing the
+    access to the filesystem.
+
+
    +SOURCE + +
        typedef struct SilcSFTPFilesystemOpsStruct {
+      /* Find a file handle by the file handle data indicated by the `data'.
+         If the handle is not found this returns NULL. */
+      SilcSFTPHandle (*sftp_get_handle)(void *context, SilcSFTP sftp,
+                                        const unsigned char *data,
+                                        SilcUInt32 data_len);
+    
+      /* Return encoded handle of `handle' or NULL on error. The caller
+         must free the returned buffer. */
+      unsigned char *(*sftp_encode_handle)(void *context, SilcSFTP sftp,
+                                           SilcSFTPHandle handle,
+                                           SilcUInt32 *handle_len);
+    
+      /* Open a file indicated by the `filename' with flags indicated by the
+         `pflags', and with attributes indicated by the `attr'.  Calls the
+         `callback' to return the opened file handle. */
+      void (*sftp_open)(void *context, SilcSFTP sftp,
+                        const char *filename,
+                        SilcSFTPFileOperation pflags,
+                        SilcSFTPAttributes attr,
+                        SilcSFTPHandleCallback callback,
+                        void *callback_context);
+    
+      /* Closes the file indicated by the file handle `handle'.  Calls the
+         `callback' to indicate the status of the closing. */
+      void (*sftp_close)(void *context, SilcSFTP sftp,
+                         SilcSFTPHandle handle,
+                         SilcSFTPStatusCallback callback,
+                         void *callback_context);
+    
+      /* Reads data from the file indicated by the file handle `handle' starting
+         from the offset of `offset' at most `len' bytes.  The `callback' is
+         called to return the read data. */
+      void (*sftp_read)(void *context, SilcSFTP sftp,
+                        SilcSFTPHandle handle,
+                        SilcUInt64 offset,
+                        SilcUInt32 len,
+                        SilcSFTPDataCallback callback,
+                        void *callback_context);
+    
+      /* Writes to a file indicated by the file handle `handle' starting from
+         offset of `offset' at most `data_len' bytes of `data'.  The `callback'
+         is called to indicate the status of the writing. */
+      void (*sftp_write)(void *context, SilcSFTP sftp,
+                         SilcSFTPHandle handle,
+                         SilcUInt64 offset,
+                         const unsigned char *data,
+                         SilcUInt32 data_len,
+                         SilcSFTPStatusCallback callback,
+                         void *callback_context);
+    
+      /* Removes a file indicated by the `filename'.  Calls the `callback'
+         to indicate the status of the removing. */
+      void (*sftp_remove)(void *context, SilcSFTP sftp,
+                          const char *filename,
+                          SilcSFTPStatusCallback callback,
+                          void *callback_context);
+    
+      /* Renames a file indicated by the `oldname' to the name `newname'.  The
+         `callback' is called to indicate the status of the renaming. */
+      void (*sftp_rename)(void *context, SilcSFTP sftp,
+                          const char *oldname,
+                          const char *newname,
+                          SilcSFTPStatusCallback callback,
+                          void *callback_context);
+    
+      /* Creates a new directory indicated by the `path' with attributes indicated
+         by the `attrs'. The `callback' is called to indicate the status of the
+         creation. */
+      void (*sftp_mkdir)(void *context, SilcSFTP sftp,
+                         const char *path,
+                         SilcSFTPAttributes attrs,
+                         SilcSFTPStatusCallback callback,
+                         void *callback_context);
+    
+      /* Removes a directory indicated by the `path' and calls the `callback'
+         to indicate the status of the removal. */
+      void (*sftp_rmdir)(void *context, SilcSFTP sftp,
+                         const char *path,
+                         SilcSFTPStatusCallback callback,
+                         void *callback_context);
+    
+      /* Opens a directory indicated by the `path'.  The `callback' is called
+         to return the opened file handle. */
+      void (*sftp_opendir)(void *context, SilcSFTP sftp,
+                           const char *path,
+                           SilcSFTPHandleCallback callback,
+                           void *callback_context);
+    
+      /* Reads the contents of the directory indicated by the `handle' and
+         calls the `callback' to return the read file(s) from the directory. */
+      void (*sftp_readdir)(void *context, SilcSFTP sftp,
+                           SilcSFTPHandle handle,
+                           SilcSFTPNameCallback callback,
+                           void *callback_context);
+    
+      /* Gets the file attributes for a file indicated by the `path'. This
+         will follow symbolic links also. Calls the `callback' to return the
+         file attributes. */
+      void (*sftp_stat)(void *context, SilcSFTP sftp,
+                        const char *path,
+                        SilcSFTPAttrCallback callback,
+                        void *callback_context);
+    
+      /* Gets the file attributes for a file indicated by the `path'. This
+         will not follow symbolic links. Calls the `callback' to return the
+         file attributes. */
+      void (*sftp_lstat)(void *context, SilcSFTP sftp,
+                         const char *path,
+                         SilcSFTPAttrCallback callback,
+                         void *callback_context);
+    
+      /* Gets a file attributes for a opened file indicated by the `handle'.
+         Calls the `callback' to return the file attributes. */
+      void (*sftp_fstat)(void *context, SilcSFTP sftp,
+                         SilcSFTPHandle handle,
+                         SilcSFTPAttrCallback callback,
+                         void *callback_context);
+    
+      /* Sets a file attributes to a file indicated by the `path' with the
+         attributes indicated by the `attrs'.  Calls the `callback' to indicate
+         the status of the setting. */
+      void (*sftp_setstat)(void *context, SilcSFTP sftp,
+                           const char *path,
+                           SilcSFTPAttributes attrs,
+                           SilcSFTPStatusCallback callback,
+                           void *callback_context);
+    
+      /* Sets a file attributes to a opened file indicated by the `handle' with
+         the attributes indicated by the `attrs'.  Calls the `callback' to
+         indicate the status of the setting. */
+      void (*sftp_fsetstat)(void *context, SilcSFTP sftp,
+                            SilcSFTPHandle handle,
+                            SilcSFTPAttributes attrs,
+                            SilcSFTPStatusCallback callback,
+                            void *callback_context);
+    
+      /* Reads the target of a symbolic link indicated by the `path'.  The
+         `callback' is called to return the target of the symbolic link. */
+      void (*sftp_readlink)(void *context, SilcSFTP sftp,
+                            const char *path,
+                            SilcSFTPNameCallback callback,
+                            void *callback_context);
+    
+      /* Creates a new symbolic link indicated by the `linkpath' to the target
+         indicated by the `targetpath'.  The `callback' is called to indicate
+         the status of creation. */
+      void (*sftp_symlink)(void *context, SilcSFTP sftp,
+                           const char *linkpath,
+                           const char *targetpath,
+                           SilcSFTPStatusCallback callback,
+                           void *callback_context);
+    
+      /* Canonicalizes the path indicated by the `path' to a absolute path.
+         The `callback' is called to return the absolute path. */
+      void (*sftp_realpath)(void *context, SilcSFTP sftp,
+                            const char *path,
+                            SilcSFTPNameCallback callback,
+                            void *callback_context);
+    
+      /* Performs an extended operation indicated by the `request' with
+         optional extended operation data indicated by the `data'.  The callback
+         is called to return any data associated with the extended request. */
+      void (*sftp_extended)(void *context, SilcSFTP sftp,
+                            const char *request,
+                            const unsigned char *data,
+                            SilcUInt32 data_len,
+                            SilcSFTPExtendedCallback callback,
+                            void *callback_context);
+    } *SilcSFTPFilesystemOps;
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_dir.html b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_dir.html new file mode 100644 index 0000000..2fbc609 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_dir.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fs_memory_add_dir

    + + +SYNOPSIS + +
    
+    void *silc_sftp_fs_memory_add_dir(SilcSFTPFilesystem fs, void *dir,
+                                      SilcSFTPFSMemoryPerm perm,
+                                      const char *name);
+
+
    +DESCRIPTION + +
    
+    Adds a new directory to the memory filesystem. Returns the directory
+    context that can be used to add for example files to the directory
+    or new subdirectories under the directory. The `dir' is the parent
+    directory of the directory to be added. If this directory is to be
+    added to the root directory the `dir' is NULL.  The `name' is the name
+    of the directory. If error occurs this returns NULL. The `perm' will
+    indicate the permissions for the directory and they work in POSIX
+    style.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_file.html b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_file.html new file mode 100644 index 0000000..eae3b67 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_add_file.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fs_memory_add_file

    + + +SYNOPSIS + +
    
+    SilcBool silc_sftp_fs_memory_add_file(SilcSFTPFilesystem fs, void *dir,
+                                          SilcSFTPFSMemoryPerm perm,
+                                          const char *filename,
+                                          const char *realpath);
+
+
    +DESCRIPTION + +
    
+    Adds a new file to the directory indicated by the `dir'.  If the `dir'
+    is NULL the file is added to the root directory. The `filename' is the
+    filename in the directory. The `realpath' is the real filepath in the
+    physical filesystem. The real path must include the schema to
+    indicate where the file is actually located.  The only supported
+    schema currently is "file://".  It is used to actually access the fil
+    from the memory filesystem. The `perm' will indicate the permissions
+    for the file and they work in POSIX style. Returns TRUE if the file
+    was added to the directory.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_alloc.html b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_alloc.html new file mode 100644 index 0000000..94179f6 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_alloc.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fs_memory_alloc

    + + +SYNOPSIS + +
    
+    void *silc_sftp_fs_memory_alloc(SilcSFTPFSMemoryPerm perm);
+
+
    +DESCRIPTION + +
    
+    Allocates memory filesystem context and returns the context.  The
+    context can be given as argument to the silc_sftp_server_start
+    function. The context must be freed by the caller using the function
+    silc_sftp_fs_memory_free. The `perm' is the permissions for the root
+    directory of the filesystem (/ dir).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_dir.html b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_dir.html new file mode 100644 index 0000000..eaa7fc2 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_dir.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fs_memory_del_dir

    + + +SYNOPSIS + +
    
+    SilcBool silc_sftp_fs_memory_del_dir(SilcSFTPFilesystem fs, void *dir);
+
+
    +DESCRIPTION + +
    
+    Deletes a directory indicated by the `dir'. All files and
+    subdirectories in this directory is also removed.  If the `dir' is
+    NULL then all directories and files are removed from the filesystem.
+    Returns TRUE if the removing was success. This is the only way to
+    remove directories in memory file system. The filesystem does not
+    allow removing directories with remote access using the filesystem
+    access function sftp_rmdir.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_file.html b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_file.html new file mode 100644 index 0000000..5237a8f --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_del_file.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fs_memory_del_file

    + + +SYNOPSIS + +
    
+    SilcBool silc_sftp_fs_memory_del_file(SilcSFTPFilesystem fs, void *dir,
+                                          const char *filename);
+
+
    +DESCRIPTION + +
    
+    Removes a file indicated by the `filename' from the directory
+    indicated by the `dir'. Returns TRUE if the removing was success. This
+    is the only way to remove files in the filesystem.  The filesystem does
+    not allow removing files with remote access using the filesystem
+    access function sftp_remove.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_free.html b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_free.html new file mode 100644 index 0000000..f86c492 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs-silc_sftp_fs_memory_free.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_sftp_fs_memory_free

    + + +SYNOPSIS + +
    
+    void silc_sftp_fs_memory_free(void *context);
+
+
    +DESCRIPTION + +
    
+    Frees the memory filesystem context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SFTP Filesystems Interface
    +SilcSFTPFilesystemOps
    +SilcSFTPFilesystem
    +SilcSFTPFSMemoryPerm
    +silc_sftp_fs_memory_alloc
    +silc_sftp_fs_memory_free
    +silc_sftp_fs_memory_add_dir
    +silc_sftp_fs_memory_del_dir
    +silc_sftp_fs_memory_add_file
    +silc_sftp_fs_memory_del_file
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs.html b/docs/toolkit/manual/silcsftp_fs.html new file mode 100644 index 0000000..326b2ab --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs.html @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsftp_fs.html + + + + +
    + +SFTP Filesystems Interface
    Header: silcsftp_fs.h

    + + +DESCRIPTION + +
    
+    SILC SFTP Filesystem interface defines filesystems for the SFTP server
+    usage.  The filesystems may be for example virtual memory filesystem
+    or real filesystem access.
+
+    Currently only implemented filesystem is memory file system.
+
+    Memory Filesystem:
+
+    Memory filesystem is a virtual filesystem which provides safe access
+    to files without actually revealing the underlaying physical filesystem
+    hierarchy or real filenames. Virtual directories can be added to the
+    filesystem and freely create filesystem hierarchy. The directories
+    can have subdirectories and files. The filesystem also provides limited
+    status information for files.  The files in the filesystem are
+    virtual but they include the path to the real file.  The real path
+    includes always a schema which indicates where the file really is
+    available.  The only supported schema currently is "file://".  In
+    the future it could support various others like "http://" and "ldap://".
+
+    The filesystem also provides security and permission handling for
+    directories and files.  Normal POSIX style permissions can be set
+    giving thus rights to reading, writing and/or executing.  They behave
+    same way as defined in POSIX.  It is also guaranteed that if the
+    writing to a file is not allowed in the memory filesystem, but it is
+    allowed in real physical filesystem the file still cannot be written.
+    However, the real physical filesystem permissions still matter, for
+    example if writing is enabled in the memory filesystem but it is not
+    enabled on physical filesystem, the file cannot be written.
+
+    The directories cannot be removed from remote access using the
+    filesystem access function sftp_rmdir.  This is because the filesystem
+    is one-user filesystem and differentiating between users is not
+    possible.  Thus, it would allow anyone to remove directories and
+    their contents.  Removing directories is possible only locally using
+    the silc_sftp_fs_memory_del_dir function.  The same thing is with
+    removing files as well.  Files too can be removed only locally using
+    the silc_sftp_fs_memory_del_file function.  Also, files can not ever
+    be executed from remote access.
+
+    Also some of the file operation flags are not supported, such as
+    SILC_SFTP_FXF_CREAT, SILC_SFTP_FXF_TRUNC and SILC_SFTP_FXF_EXCL
+    since they would require access to a real filesystem file which does
+    not exist yet, or would mean destroying the file.  However, the
+    SILC_SFTP_FXF_WRITE is supported since the file aready exists.
+
+    The memory filesystem does not provide symbolic links.
+
+
  • SilcSFTPFilesystemOps +
  • SilcSFTPFilesystem +
  • SilcSFTPFSMemoryPerm +
  • silc_sftp_fs_memory_alloc +
  • silc_sftp_fs_memory_free +
  • silc_sftp_fs_memory_add_dir +
  • silc_sftp_fs_memory_del_dir +
  • silc_sftp_fs_memory_add_file +
  • silc_sftp_fs_memory_del_file + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsftp_fs.xref b/docs/toolkit/manual/silcsftp_fs.xref new file mode 100644 index 0000000..e303181 --- /dev/null +++ b/docs/toolkit/manual/silcsftp_fs.xref @@ -0,0 +1,16 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsftp_fs.h" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 0 + "SFTP Filesystems Interface" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 1 + "SilcSFTPFilesystemOps" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 5 + "SilcSFTPFilesystem" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 5 + "SilcSFTPFSMemoryPerm" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 8 + "silc_sftp_fs_memory_alloc" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 4 + "silc_sftp_fs_memory_free" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 4 + "silc_sftp_fs_memory_add_dir" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 4 + "silc_sftp_fs_memory_del_dir" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 4 + "silc_sftp_fs_memory_add_file" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 4 + "silc_sftp_fs_memory_del_file" "/home/priikone/silc1/doc/toolkit/silcsftp_fs.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcsftplib.html b/docs/toolkit/manual/silcsftplib.html new file mode 100644 index 0000000..e65d3a4 --- /dev/null +++ b/docs/toolkit/manual/silcsftplib.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC SFTP Library +
    +Directory: lib/silcsftp/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC SFTP Library provides Secure File Transfer Protocol client and server +implementation. The SFTP protocol is the mandatory file transfer protocol +used for file transfers in the SILC protocol. The same interface is used +for SFTP client and SFTP server. + +

    + +
  • SILC SFTP Interface +
  • SFTP Filesystems Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsim.html b/docs/toolkit/manual/silcsim.html new file mode 100644 index 0000000..f75b17c --- /dev/null +++ b/docs/toolkit/manual/silcsim.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsim.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsim.xref b/docs/toolkit/manual/silcsim.xref new file mode 100644 index 0000000..403eed9 --- /dev/null +++ b/docs/toolkit/manual/silcsim.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsim.h" "/home/priikone/silc1/doc/toolkit/silcsim.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcsimutil.html b/docs/toolkit/manual/silcsimutil.html new file mode 100644 index 0000000..acc58fe --- /dev/null +++ b/docs/toolkit/manual/silcsimutil.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsimutil.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsimutil.xref b/docs/toolkit/manual/silcsimutil.xref new file mode 100644 index 0000000..9fade42 --- /dev/null +++ b/docs/toolkit/manual/silcsimutil.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsimutil.h" "/home/priikone/silc1/doc/toolkit/silcsimutil.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcske-SilcSKECompletionCb.html b/docs/toolkit/manual/silcske-SilcSKECompletionCb.html new file mode 100644 index 0000000..522d00e --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKECompletionCb.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSKECompletionCb

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSKECompletionCb)(SilcSKE ske,
+                                        SilcSKEStatus status,
+                                        const SilcSKESecurityProperties prop,
+                                        const SilcSKEKeyMaterial keymat,
+                                        SilcSKERekeyMaterial rekey,
+                                        void *context);
+
+
    +DESCRIPTION + +
    
+    Completion callback.  This is called after the key exchange protocol
+    has been completed.  It delivers the status of the protocol, and if
+    successful the security properties `prop' that was negotiated in the
+    protocol and the key material `keymat' that can be set into use by
+    calling silc_ske_set_keys, and the rekey key material `rekey' which
+    can be used later to start rekey protocol.  The `prop' and `keymat'
+    will remain valid as long as `ske' is valid.  The `rekey' will remain
+    valid until silc_ske_free_rekey_material is called.  The application
+    must call it to free the `rekey'.
+
+    When doing rekey, this completion callback delivers the `keymat' and
+    new `rekey'.  The `prop' is ignored.  The `keymat' has already been set
+    to the packet stream associated with the `ske'.  Thus, after this
+    is called the new keys are in use.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKEKeyMaterial.html b/docs/toolkit/manual/silcske-SilcSKEKeyMaterial.html new file mode 100644 index 0000000..6b7287e --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKEKeyMaterial.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKEKeyMaterial

    + + +NAME + +
    
+    typedef struct { ... } *SilcSKEKeyMaterial;
+
+
    +DESCRIPTION + +
    
+    This is the key material structure, and is passed as argument by the
+    application to silc_ske_process_key_material_data function. It includes
+    the processed key material which can be used as SILC session keys.
+
+
    +SOURCE + +
        typedef struct SilcSKEKeyMaterialStruct {
+      unsigned char *send_iv;
+      unsigned char *receive_iv;
+      SilcUInt32 iv_len;
+      unsigned char *send_enc_key;
+      unsigned char *receive_enc_key;
+      SilcUInt32 enc_key_len;              /* Key length in bits */
+      unsigned char *send_hmac_key;
+      unsigned char *receive_hmac_key;
+      SilcUInt32 hmac_key_len;             /* Key length in bytes */
+    } *SilcSKEKeyMaterial;
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKEPKType.html b/docs/toolkit/manual/silcske-SilcSKEPKType.html new file mode 100644 index 0000000..d064bfe --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKEPKType.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSKEPKType

    + + +NAME + +
    
+    typedef enum { ... } SilcSKEPKType;
+
+
    +DESCRIPTION + +
    
+    Public key and certificate types defined by the SKE protocol.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SKE_PK_TYPE_SILC    = 1, /* SILC Public Key, mandatory */
+      SILC_SKE_PK_TYPE_SSH2    = 2, /* SSH2 Public key, not supported */
+      SILC_SKE_PK_TYPE_X509V3  = 3, /* X.509v3 certificate, not supported */
+      SILC_SKE_PK_TYPE_OPENPGP = 4, /* OpenPGP certificate, not supported */
+      SILC_SKE_PK_TYPE_SPKI    = 5  /* SPKI certificate, not supported */
+    } SilcSKEPKType;
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKEParams.html b/docs/toolkit/manual/silcske-SilcSKEParams.html new file mode 100644 index 0000000..a805d97 --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKEParams.html @@ -0,0 +1,279 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKEParams

    + + +NAME + +
    
+    typedef struct { ... } *SilcSKEParams, SilcSKEParamsStruct;
+
+
    +DESCRIPTION + +
    
+    SKE parameters structure.  This structure is given as argument to
+    silc_ske_initiator and silc_ske_responder functions.
+
+
    +SOURCE + +
        typedef struct SilcSKEParamsObject {
+      /* The SKE version string that is sent to the remote end.  This field
+         must be set.  Caller must free the pointer. */
+      char *version;
+    
+      /* Security property flags.  When initiator sets these it requests them
+         from the responder.  Responder may set here the flags it supports
+         and wants to enforce for the initiator. */
+      SilcSKESecurityPropertyFlag flags;
+    
+      /* SILC Session port when using UDP/IP and SILC_SKE_SP_FLAG_IV_INCLUDED
+         flag.  It is the port the remote will use as SILC session port after
+         the key exchange protocol.  Ignored without SILC_SKE_SP_FLAG_IV_INCLUDED
+         flag. */
+      SilcUInt16 session_port;
+    
+      /* Key exchange timeout in seconds.  If key exchange is not completed in
+         this time it will timeout.  If not specified (zero), default value
+         (30 seconds) will be used. */
+      SilcUInt16 timeout_secs;
+    
+      /* Same as timeout_secs but affects only the first packet sent as
+         initiator.  If the responder does not reply to the first packet in this
+         time frame the key exchange will timeout.  If not specified (zero),
+         default value (30 seconds) will be used. */
+      SilcUInt16 probe_timeout_secs;
+    
+      /* If TRUE small proposal is sent with only one security property
+         proposed instead of list of all currently registered. */
+      SilcBool small_proposal;
+    
+      /* If TRUE protocol does not end in SUCCESS acknowledgements. */
+      SilcBool no_acks;
+    
+      /* Pre-allocated security properties to use in negotiation.  If provided
+         the library will perform only key exchange and proposals aren't
+         exchanged at all. */
+      SilcSKESecurityProperties prop;
+    } *SilcSKEParams, SilcSKEParamsStruct;
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKERekeyMaterial.html b/docs/toolkit/manual/silcske-SilcSKERekeyMaterial.html new file mode 100644 index 0000000..61ba842 --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKERekeyMaterial.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKERekeyMaterial

    + + +NAME + +
    
+    typedef struct { ... } *SilcSKERekeyMaterial;
+
+
    +DESCRIPTION + +
    
+    This context is returned after key exchange protocol to application
+    in the completion callback.  Application may save it and use it later
+    to perform the rekey with silc_ske_rekey_initiator and/or
+    silc_ske_rekey_responder functions.  If application does not
+    need the context, it may free it with silc_ske_free_rekey_material
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKESecurityProperties.html b/docs/toolkit/manual/silcske-SilcSKESecurityProperties.html new file mode 100644 index 0000000..0fd7109 --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKESecurityProperties.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKESecurityProperties

    + + +NAME + +
    
+    typedef struct { ... } *SilcSKESecurityProperties;
+
+
    +DESCRIPTION + +
    
+    Security Properties negotiated between key exchange parties. This
+    structure is filled from the Key Exchange Start Payload which is used
+    to negotiate what security properties must be used in the
+    communication.
+
+
    +SOURCE + +
        typedef struct SilcSKESecurityPropertiesStruct {
+      SilcSKESecurityPropertyFlag flags;     /* Flags */
+      SilcSKEDiffieHellmanGroup group;       /* Selected Diffie Hellman group */
+      SilcCipher cipher;                     /* Selected cipher */
+      SilcHmac hmac;                         /* Selected HMAC */
+      SilcHash hash;                         /* Selected hash algorithm */
+      SilcPublicKey public_key;              /* Remote public key */
+      SilcUInt16 remote_port;                /* Remote port, set when IV Included
+                                                set and using UDP/IP */
+    } *SilcSKESecurityProperties;
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKESecurityPropertyFlag.html b/docs/toolkit/manual/silcske-SilcSKESecurityPropertyFlag.html new file mode 100644 index 0000000..7f8b9a4 --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKESecurityPropertyFlag.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSKESecurityPropertyFlag

    + + +NAME + +
    
+    typedef enum { ... } SilcSKESecurityPropertyFlag
+
+
    +DESCRIPTION + +
    
+    SKE security property flags as defined by the SK protocol.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SKE_SP_FLAG_NONE         = 0x00,  /* No flags */
+      SILC_SKE_SP_FLAG_IV_INCLUDED  = 0x01,  /* IV included in packet */
+      SILC_SKE_SP_FLAG_PFS          = 0x02,  /* Perfect Forward Secrecy */
+      SILC_SKE_SP_FLAG_MUTUAL       = 0x04,  /* Mutual authentication */
+    } SilcSKESecurityPropertyFlag;
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKEStatus.html b/docs/toolkit/manual/silcske-SilcSKEStatus.html new file mode 100644 index 0000000..69a80b1 --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKEStatus.html @@ -0,0 +1,265 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSKEStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcSKEStatus;
+
+
    +DESCRIPTION + +
    
+    Status types returned in SKE callbacks. This tell the status of
+    the SKE session, and if an error occurred. Application can map the
+    status to human readable string with silc_ske_map_status function.
+
+
    +SOURCE + +
        typedef enum {
+      /* These are defined by the protocol */
+      SILC_SKE_STATUS_OK                     = 0,  /* No error */
+      SILC_SKE_STATUS_ERROR                  = 1,  /* Unknown error */
+      SILC_SKE_STATUS_BAD_PAYLOAD            = 2,  /* Malformed payload */
+      SILC_SKE_STATUS_UNKNOWN_GROUP          = 3,  /* Unsupported DH group */
+      SILC_SKE_STATUS_UNKNOWN_CIPHER         = 4,  /* Unsupported cipher */
+      SILC_SKE_STATUS_UNKNOWN_PKCS           = 5,  /* Unsupported PKCS algorithm */
+      SILC_SKE_STATUS_UNKNOWN_HASH_FUNCTION  = 6,  /* Unsupported hash function */
+      SILC_SKE_STATUS_UNKNOWN_HMAC           = 7,  /* Unsupported HMAC */
+      SILC_SKE_STATUS_UNSUPPORTED_PUBLIC_KEY = 8,  /* Unsupported/not trusted PK */
+      SILC_SKE_STATUS_INCORRECT_SIGNATURE    = 9,  /* Incorrect signature */
+      SILC_SKE_STATUS_BAD_VERSION            = 10, /* Unsupported version */
+      SILC_SKE_STATUS_INVALID_COOKIE         = 11, /* Cookie was modified */
+    
+      /* Implementation specific status types */
+      SILC_SKE_STATUS_PUBLIC_KEY_NOT_PROVIDED,     /* Remote did not send PK */
+      SILC_SKE_STATUS_BAD_RESERVED_FIELD,          /* Reserved field was not 0 */
+      SILC_SKE_STATUS_BAD_PAYLOAD_LENGTH,          /* Payload includes garbage */
+      SILC_SKE_STATUS_SIGNATURE_ERROR,             /* Error computing signature */
+      SILC_SKE_STATUS_OUT_OF_MEMORY,               /* System out of memory */
+      SILC_SKE_STATUS_TIMEOUT,                     /* Timeout */
+      SILC_SKE_STATUS_PROBE_TIMEOUT,               /* Probe timeout */
+    } SilcSKEStatus;
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKEVerifyCb.html b/docs/toolkit/manual/silcske-SilcSKEVerifyCb.html new file mode 100644 index 0000000..8ec3650 --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKEVerifyCb.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSKEVerifyCb

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSKEVerifyCb)(SilcSKE ske,
+                                    SilcPublicKey public_key,
+                                    void *context,
+                                    SilcSKEVerifyCbCompletion completion,
+                                    void *completion_context);
+
+
    +DESCRIPTION + +
    
+    Callback function used to verify the received public key or certificate.
+    The verification process is most likely asynchronous.  That's why the
+    application must call the `completion' callback when the verification
+    process has been completed.  The `context' is the context given as
+    arugment to silc_ske_set_callbacks.  See silc_ske_set_callbacks for
+    more information.
+
+    If the key repository was provided in silc_ske_alloc this callback
+    is called only if the public key was not found from the repository.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-SilcSKEVerifyCbCompletion.html b/docs/toolkit/manual/silcske-SilcSKEVerifyCbCompletion.html new file mode 100644 index 0000000..5936386 --- /dev/null +++ b/docs/toolkit/manual/silcske-SilcSKEVerifyCbCompletion.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSKEVerifyCbCompletion

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSKEVerifyCbCompletion)(SilcSKE ske,
+                                              SilcSKEStatus status,
+                                              void *context);
+
+
    +DESCRIPTION + +
    
+    Completion callback that will be called when the public key
+    has been verified.  The `status' will indicate whether the public
+    key were trusted or not.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_alloc.html b/docs/toolkit/manual/silcske-silc_ske_alloc.html new file mode 100644 index 0000000..7b47211 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_alloc.html @@ -0,0 +1,270 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_alloc

    + + +SYNOPSIS + +
    
+    SilcSKE silc_ske_alloc(SilcRng rng, SilcSchedule schedule,
+                           SilcSKR repository, SilcPublicKey public_key,
+                           SilcPrivateKey private_key, void *context);
+
+
    +DESCRIPTION + +
    
+    Allocates the SKE session context and returns it.  The `rng' is
+    the random number generator the SKE is going to use when it needs
+    random number generation during the SKE session.  The `context' is
+    user context that the libary will not touch.  Application can get the
+    context by calling the fuction silc_ske_get_context function.  The
+    application is responsible of freeing the `context'.  After the
+    SKE session context is allocated application must call the
+    silc_ske_set_callbacks.
+
+    If the `repository' is non-NULL then the remote's public key will be
+    verified from the repository.  If it is not provided then the
+    SilcSKEVerifyCb callback must be set, and it will be called to
+    verify the key.  If both `repository' and the callback is provided the
+    callback is called only if the key is not found from the repository.
+
+    The `public_key' and `private_key' is the caller's identity used
+    during the key exchange.  Giving `private_key' is optional if the
+    SILC_SKE_SP_FLAG_MUTUAL is not set and you are initiator.  For
+    responder both `public_key' and `private_key' must be set.
+
+    When allocating SKE session for rekey, the `repository' and `private_key'
+    pointers must be NULL and the SilcSKEVerifyCb callback must not be
+    set with silc_ske_set_callbacks.
+
+ EXMPALE
+
+    // Initiator example
+    params.version = version;
+    params.flags = SILC_SKE_SP_FLAG_PFS | SILC_SKE_SP_FLAG_MUTUAL;
+    ske = silc_ske_alloc(rng, scheduler, NULL, pk, prv, app);
+    silc_ske_set_callbacks(ske, verify_public_key, completion, app);
+    silc_ske_initiator(ske, stream, &params, NULL);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_free.html b/docs/toolkit/manual/silcske-silc_ske_free.html new file mode 100644 index 0000000..435694a --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_free.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_free

    + + +SYNOPSIS + +
    
+    void silc_ske_free(SilcSKE ske);
+
+
    +DESCRIPTION + +
    
+    Frees the SKE session context and all allocated resources.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_free_key_material.html b/docs/toolkit/manual/silcske-silc_ske_free_key_material.html new file mode 100644 index 0000000..afe202b --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_free_key_material.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_free_key_material

    + + +SYNOPSIS + +
    
+    void silc_ske_free_key_material(SilcSKEKeyMaterial key)
+
+
    +DESCRIPTION + +
    
+    Utility function to free the key material created by calling
+    silc_ske_process_key_material_data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_free_rekey_material.html b/docs/toolkit/manual/silcske-silc_ske_free_rekey_material.html new file mode 100644 index 0000000..a500d98 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_free_rekey_material.html @@ -0,0 +1,238 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_free_rekey_material

    + + +SYNOPSIS + +
    
+    void silc_ske_free_rekey_material(SilcSKERekeyMaterial rekey);
+
+
    +DESCRIPTION + +
    
+    Utility function to free the rekey material returned in the
+    SilcSKECompletionCb callback.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_get_context.html b/docs/toolkit/manual/silcske-silc_ske_get_context.html new file mode 100644 index 0000000..d488372 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_get_context.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_get_context

    + + +SYNOPSIS + +
    
+    void *silc_ske_get_context(SilcSKE ske);
+
+
    +DESCRIPTION + +
    
+    Returns the context that was given as argument to silc_ske_alloc.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_get_key_material.html b/docs/toolkit/manual/silcske-silc_ske_get_key_material.html new file mode 100644 index 0000000..bd17dcf --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_get_key_material.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_get_key_material

    + + +SYNOPSIS + +
    
+    SilcSKEKeyMaterial silc_ske_get_key_material(SilcSKE ske);
+
+
    +DESCRIPTION + +
    
+    Returns the negotiated key material from the `ske' or NULL if the
+    key material does not exist.  The caller must not free the returned
+    pointer.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_get_security_properties.html b/docs/toolkit/manual/silcske-silc_ske_get_security_properties.html new file mode 100644 index 0000000..12072e6 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_get_security_properties.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_get_security_properties

    + + +SYNOPSIS + +
    
+    SilcSKESecurityProperties silc_ske_get_security_properties(SilcSKE ske);
+
+
    +DESCRIPTION + +
    
+    Returns negotiated security properties from the `ske' or NULL if they
+    have not yet been negotiated.  This may be called to retrieve the
+    security properties after the SilcSKECompletionCb has been called.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_initiator.html b/docs/toolkit/manual/silcske-silc_ske_initiator.html new file mode 100644 index 0000000..82e1a00 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_initiator.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_initiator

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_ske_initiator(SilcSKE ske,
+                       SilcPacketStream stream,
+                       SilcSKEParams params,
+                       SilcSKEStartPayload start_payload);
+
+
    +DESCRIPTION + +
    
+    Starts the SILC Key Exchange protocol as initiator.  The completion
+    callback that was set in silc_ske_set_callbacks will be called once
+    the protocol has completed.  The `stream' is the network connection
+    to the remote host.  The SKE library will handle all key exchange
+    packets sent and received in the `stream' connection.  The library will
+    also set the remote host's ID automatically to the `stream' if it is
+    present in the exchanged packets.  The `params' include SKE parameters,
+    and it must be provided.
+
+    If the `start_payload' is NULL the library will generate it
+    automatically.  Caller may provide it if it wants to send its own
+    security properties instead of using the default ones library
+    generates.  If caller provides it, it must not free it once it has
+    been given as argument to this function.
+
+    This function returns SilcAsyncOperation operation context which can
+    be used to control the protocol from the application.  Application may
+    for example safely abort the protocol at any point, if needed.  Returns
+    NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_map_status.html b/docs/toolkit/manual/silcske-silc_ske_map_status.html new file mode 100644 index 0000000..7c4bfe8 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_map_status.html @@ -0,0 +1,237 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_map_status

    + + +SYNOPSIS + +
    
+    const char *silc_ske_map_status(SilcSKEStatus status);
+
+
    +DESCRIPTION + +
    
+    Utility function to map the `status' into human readable message.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_parse_version.html b/docs/toolkit/manual/silcske-silc_ske_parse_version.html new file mode 100644 index 0000000..79d4e96 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_parse_version.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_parse_version

    + + +SYNOPSIS + +
    
+    SilcBool silc_ske_parse_version(SilcSKE ske,
+                                    SilcUInt32 *protocol_version,
+                                    char **protocol_version_string,
+                                    SilcUInt32 *software_version,
+                                    char **software_version_string,
+                                    char **vendor_version);
+
+
    +DESCRIPTION + +
    
+    Utility function to parse the remote host's version string.  This can
+    be called after the key exchange has been completed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_process_key_material_data.html b/docs/toolkit/manual/silcske-silc_ske_process_key_material_data.html new file mode 100644 index 0000000..d9cf916 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_process_key_material_data.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_process_key_material_data

    + + +SYNOPSIS + +
    
+    const char *silc_ske_map_status(SilcSKEStatus status);
+
+
    +DESCRIPTION + +
    
+    Utility function to process key data `data' in the way specified
+    by the SILC Key Exchange protocol.  This returns the processed key
+    material or NULL on error.  Caller must free the returned key
+    material context by calling silc_ske_free_key_material.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_rekey_initiator.html b/docs/toolkit/manual/silcske-silc_ske_rekey_initiator.html new file mode 100644 index 0000000..1afbf1c --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_rekey_initiator.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_rekey_initiator

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_ske_rekey_initiator(SilcSKE ske,
+                             SilcPacketStream stream,
+                             SilcSKERekeyMaterial rekey);
+
+
    +DESCRIPTION + +
    
+    Starts SILC Key Exchange key regeneration (rekey) protocol.  The `rekey'
+    is the rekey material received earlier in SilcSKECompletionCb.  That
+    same callback is called after the rekey protocol is over to deliver new
+    key material and new rekey material.  When the rekey is completed the
+    SKE library will automatically update the new keys into `stream'.  The
+    completion callback is called after the new keys has been taken into
+    use.
+
+    This function returns SilcAsyncOperation operation context which can
+    be used to control the protocol from the application.  Application may
+    for example safely abort the protocol at any point, if needed.  Returns
+    NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_rekey_responder.html b/docs/toolkit/manual/silcske-silc_ske_rekey_responder.html new file mode 100644 index 0000000..e06d1c9 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_rekey_responder.html @@ -0,0 +1,256 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_rekey_responder

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_ske_rekey_responder(SilcSKE ske,
+                             SilcPacketStream stream,
+                             SilcSKERekeyMaterial rekey,
+                             SilcPacket packet);
+
+
    +DESCRIPTION + +
    
+    Starts SILC Key Exchange key regeneration (rekey) protocol as responder.
+    The `rekey' is the rekey material received earlier in
+    SilcSKECompletionCb.  That same callback is called after the rekey
+    protocol is over to deliver new key material and new rekey material.
+    When the rekey is completed the SKE library will automatically update
+    the new keys into `stream'.  The completion callback is called after
+    the new keys has been taken into use.
+
+    The `packet' is the SILC_PACKET_REKEY received to start the rekey
+    protocol.  If `packet' is NULL it is assumed that the packet will be
+    received from the `stream'.
+
+    This function returns SilcAsyncOperation operation context which can
+    be used to control the protocol from the application.  Application may
+    for example safely abort the protocol at any point, if needed.  Returns
+    NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_responder.html b/docs/toolkit/manual/silcske-silc_ske_responder.html new file mode 100644 index 0000000..9c57319 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_responder.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_responder

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_ske_responder(SilcSKE ske,
+                       SilcPacketStream stream,
+                       SilcSKEParams params);
+
+
    +DESCRIPTION + +
    
+    Starts SILC Key Exchange protocol as responder.  The completion
+    callback that was set in silc_ske_set_callbacks will be called once
+    the protocol has completed.  The `stream' is the network connection
+    to the remote host.  The SKE library will handle all key exchange
+    packets sent and received in the `stream' connection.  The library will
+    also set the remote hosts's ID automatically to the `stream' if it is
+    present in the exchanged packets.  The `params' include SKE parameters,
+    and must be provided.
+
+    This function returns SilcAsyncOperation operation context which can
+    be used to control the protocol from the application.  Application may
+    for example safely abort the protocol at any point, if needed.  Returns
+    NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_set_callbacks.html b/docs/toolkit/manual/silcske-silc_ske_set_callbacks.html new file mode 100644 index 0000000..8120604 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_set_callbacks.html @@ -0,0 +1,255 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_set_callbacks

    + + +SYNOPSIS + +
    
+    void silc_ske_set_callbacks(SilcSKE ske,
+                                SilcSKEVerifyCb verify_key,
+                                SilcSKECompletion completed,
+                                void *context);
+
+
    +DESCRIPTION + +
    
+    Sets the callback functions for the SKE session.
+
+    The `verify_key' callback is called to verify the received public key
+    or certificate.  The verification process is most likely asynchronous.
+    That is why the application must call the completion callback when the
+    verification process has been completed.  If this SKE session context
+    is used to perform rekey, this callback usually is not provided as
+    argument since sending public key in rekey is not mandatory.  Setting
+    this callback implies that remote end MUST send its public key.
+
+    The `completed' callback will be called once the protocol has completed,
+    either successfully or with an error.  The status of the protocol is
+    delivered to application with the callback.
+
+    The `context' is passed as argument to all of the above callback
+    functions.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske-silc_ske_set_keys.html b/docs/toolkit/manual/silcske-silc_ske_set_keys.html new file mode 100644 index 0000000..fe14740 --- /dev/null +++ b/docs/toolkit/manual/silcske-silc_ske_set_keys.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_set_keys

    + + +SYNOPSIS + +
    
+    SilcBool silc_ske_set_keys(SilcSKE ske,
+                               SilcSKEKeyMaterial keymat,
+                               SilcSKESecurityProperties prop,
+                               SilcCipher *ret_send_key,
+                               SilcCipher *ret_receive_key,
+                               SilcHmac *ret_hmac_send,
+                               SilcHmac *ret_hmac_receive,
+                               SilcHash *ret_hash);
+
+
    +DESCRIPTION + +
    
+    This function can be used after successful key exchange to take the
+    key material `keymat' with security properties `prop' into use.
+    This will allocate send and receive ciphers, HMACs and hash for the
+    application.  Caller must free the returned contexts.  This is an
+    utility function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC SKE Interface
    +SilcSKEStatus
    +SilcSKESecurityPropertyFlag
    +SilcSKESecurityProperties
    +SilcSKEKeyMaterial
    +SilcSKERekeyMaterial
    +SilcSKEParams
    +SilcSKEPKType
    +SilcSKEVerifyCbCompletion
    +SilcSKEVerifyCb
    +SilcSKECompletionCb
    +silc_ske_alloc
    +silc_ske_free
    +silc_ske_get_context
    +silc_ske_set_callbacks
    +silc_ske_initiator
    +silc_ske_responder
    +silc_ske_rekey_initiator
    +silc_ske_rekey_responder
    +silc_ske_set_keys
    +silc_ske_parse_version
    +silc_ske_get_security_properties
    +silc_ske_get_key_material
    +silc_ske_process_key_material_data
    +silc_ske_free_key_material
    +silc_ske_free_rekey_material
    +silc_ske_map_status
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske.html b/docs/toolkit/manual/silcske.html new file mode 100644 index 0000000..1405ce0 --- /dev/null +++ b/docs/toolkit/manual/silcske.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcske.html + + + + +
    + +SILC SKE Interface
    Header: silcske.h

    + + +DESCRIPTION + +
    
+ The SILC Key Exchange (SKE) protocol interface. The SKE protocol
+ is used to negotiate secret key material between two parties, to be used
+ as session key or some other key. For example, when client connects to
+ server SKE is performed to exchange public keys, and to generate the key
+ that is then used as session key. Two clients can execute SKE as well
+ two create secret key material for securing for example file transfer
+ stream. This SKE implementation provides easy interface for application
+ that wants to use SKE.
+
+
  • SilcSKEStatus +
  • SilcSKESecurityPropertyFlag +
  • SilcSKESecurityProperties +
  • SilcSKEKeyMaterial +
  • SilcSKERekeyMaterial +
  • SilcSKEParams +
  • SilcSKEPKType +
  • SilcSKEVerifyCbCompletion +
  • SilcSKEVerifyCb +
  • SilcSKECompletionCb +
  • silc_ske_alloc +
  • silc_ske_free +
  • silc_ske_get_context +
  • silc_ske_set_callbacks +
  • silc_ske_initiator +
  • silc_ske_responder +
  • silc_ske_rekey_initiator +
  • silc_ske_rekey_responder +
  • silc_ske_set_keys +
  • silc_ske_parse_version +
  • silc_ske_get_security_properties +
  • silc_ske_get_key_material +
  • silc_ske_process_key_material_data +
  • silc_ske_free_key_material +
  • silc_ske_free_rekey_material +
  • silc_ske_map_status + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske.xref b/docs/toolkit/manual/silcske.xref new file mode 100644 index 0000000..dc3e50b --- /dev/null +++ b/docs/toolkit/manual/silcske.xref @@ -0,0 +1,33 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcske.h" "/home/priikone/silc1/doc/toolkit/silcske.html" 0 + "SILC SKE Interface" "/home/priikone/silc1/doc/toolkit/silcske.html" 1 + "SilcSKEStatus" "/home/priikone/silc1/doc/toolkit/silcske.html" 8 + "SilcSKESecurityPropertyFlag" "/home/priikone/silc1/doc/toolkit/silcske.html" 8 + "SilcSKESecurityProperties" "/home/priikone/silc1/doc/toolkit/silcske.html" 5 + "SilcSKEKeyMaterial" "/home/priikone/silc1/doc/toolkit/silcske.html" 5 + "SilcSKERekeyMaterial" "/home/priikone/silc1/doc/toolkit/silcske.html" 5 + "SilcSKEParams" "/home/priikone/silc1/doc/toolkit/silcske.html" 5 + "SilcSKEPKType" "/home/priikone/silc1/doc/toolkit/silcske.html" 8 + "SilcSKEVerifyCbCompletion" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "SilcSKEVerifyCb" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "SilcSKECompletionCb" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_alloc" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_free" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_get_context" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_set_callbacks" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_initiator" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_responder" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_rekey_initiator" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_rekey_responder" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_set_keys" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_parse_version" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_get_security_properties" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_get_key_material" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_process_key_material_data" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_free_key_material" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_free_rekey_material" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + "silc_ske_map_status" "/home/priikone/silc1/doc/toolkit/silcske.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcske_groups-SilcSKEDiffieHellmanGroup.html b/docs/toolkit/manual/silcske_groups-SilcSKEDiffieHellmanGroup.html new file mode 100644 index 0000000..e4d16a8 --- /dev/null +++ b/docs/toolkit/manual/silcske_groups-SilcSKEDiffieHellmanGroup.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKEDiffieHellmanGroup

    + + +NAME + +
    
+    typedef struct SilcSKEDiffieHellmanGroupStruct
+                     *SilcSKEDiffieHellmanGroup;
+
+
    +DESCRIPTION + +
    
+    This context represents one Diffie Hellman group, and is returned
+    by the utility functions for finding correct groups.  The context
+    is freed by calling the silc_ske_group_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Diffie Hellman Groups
    +SilcSKEDiffieHellmanGroup
    +silc_ske_group_get_by_number
    +silc_ske_group_get_by_name
    +silc_ske_group_free
    +silc_ske_get_supported_groups
    +silc_ske_group_get_number
    +silc_ske_group_get_name
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups-silc_ske_get_supported_groups.html b/docs/toolkit/manual/silcske_groups-silc_ske_get_supported_groups.html new file mode 100644 index 0000000..50ac0fb --- /dev/null +++ b/docs/toolkit/manual/silcske_groups-silc_ske_get_supported_groups.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_get_supported_groups

    + + +SYNOPSIS + +
    
+    char *silc_ske_get_supported_groups(SilcUInt32 limit);
+
+
    +DESCRIPTION + +
    
+    Returns a comma separated list of support Diffie Hellman groups.
+    This can be used to get the list of supported groups for SKE
+    packets.  The `limit' specifies the maximum number of groups
+    to return.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Diffie Hellman Groups
    +SilcSKEDiffieHellmanGroup
    +silc_ske_group_get_by_number
    +silc_ske_group_get_by_name
    +silc_ske_group_free
    +silc_ske_get_supported_groups
    +silc_ske_group_get_number
    +silc_ske_group_get_name
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups-silc_ske_group_free.html b/docs/toolkit/manual/silcske_groups-silc_ske_group_free.html new file mode 100644 index 0000000..1218813 --- /dev/null +++ b/docs/toolkit/manual/silcske_groups-silc_ske_group_free.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_group_free

    + + +SYNOPSIS + +
    
+    void silc_ske_group_free(SilcSKEDiffieHellmanGroup group);
+
+
    +DESCRIPTION + +
    
+    Free the Diffie Hellman group indicated by the `group'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Diffie Hellman Groups
    +SilcSKEDiffieHellmanGroup
    +silc_ske_group_get_by_number
    +silc_ske_group_get_by_name
    +silc_ske_group_free
    +silc_ske_get_supported_groups
    +silc_ske_group_get_number
    +silc_ske_group_get_name
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_name.html b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_name.html new file mode 100644 index 0000000..a4d6c5a --- /dev/null +++ b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_name.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_group_get_by_name

    + + +SYNOPSIS + +
    
+    SilcSKEStatus
+    silc_ske_get_group_by_name(const char *name,
+                               SilcSKEDiffieHellmanGroup *ret);
+
+
    +DESCRIPTION + +
    
+    Returns the Diffie Hellman group into the `ret' pointer by
+    group name indicated by the `name'.  Returns error status
+    if the group was not found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Diffie Hellman Groups
    +SilcSKEDiffieHellmanGroup
    +silc_ske_group_get_by_number
    +silc_ske_group_get_by_name
    +silc_ske_group_free
    +silc_ske_get_supported_groups
    +silc_ske_group_get_number
    +silc_ske_group_get_name
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_number.html b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_number.html new file mode 100644 index 0000000..06c9a6f --- /dev/null +++ b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_by_number.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_group_get_by_number

    + + +SYNOPSIS + +
    
+    SilcSKEStatus
+    silc_ske_group_get_by_number(int number,
+                                 SilcSKEDiffieHellmanGroup *ret);
+
+
    +DESCRIPTION + +
    
+    Returns the Diffie Hellman group into the `ret' pointer by
+    group number indicated by the `number'.  Returns error status
+    if the group was not found.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Diffie Hellman Groups
    +SilcSKEDiffieHellmanGroup
    +silc_ske_group_get_by_number
    +silc_ske_group_get_by_name
    +silc_ske_group_free
    +silc_ske_get_supported_groups
    +silc_ske_group_get_number
    +silc_ske_group_get_name
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups-silc_ske_group_get_name.html b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_name.html new file mode 100644 index 0000000..51d5c31 --- /dev/null +++ b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_name.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_group_get_name

    + + +SYNOPSIS + +
    
+    const char *silc_ske_group_get_name(SilcSKEDiffieHellmanGroup group);
+
+
    +DESCRIPTION + +
    
+    Return the group name of the group indicated by the `group'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Diffie Hellman Groups
    +SilcSKEDiffieHellmanGroup
    +silc_ske_group_get_by_number
    +silc_ske_group_get_by_name
    +silc_ske_group_free
    +silc_ske_get_supported_groups
    +silc_ske_group_get_number
    +silc_ske_group_get_name
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups-silc_ske_group_get_number.html b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_number.html new file mode 100644 index 0000000..d4786f8 --- /dev/null +++ b/docs/toolkit/manual/silcske_groups-silc_ske_group_get_number.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_group_get_number

    + + +SYNOPSIS + +
    
+    int silc_ske_group_get_number(SilcSKEDiffieHellmanGroup group);
+
+
    +DESCRIPTION + +
    
+    Return the group number of the group indicated by the `group'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Diffie Hellman Groups
    +SilcSKEDiffieHellmanGroup
    +silc_ske_group_get_by_number
    +silc_ske_group_get_by_name
    +silc_ske_group_free
    +silc_ske_get_supported_groups
    +silc_ske_group_get_number
    +silc_ske_group_get_name
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups.html b/docs/toolkit/manual/silcske_groups.html new file mode 100644 index 0000000..6859b56 --- /dev/null +++ b/docs/toolkit/manual/silcske_groups.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcske_groups.html + + + + +
    + +SKE Diffie Hellman Groups
    Header: silcske_groups.h

    + + +DESCRIPTION + +
    
+ This interface defines the Diffie Hellman group management and utility
+ functions for the SKE.  They can be used find DH groups by group number,
+ and group name.  These routines are used during the SKE session by the
+ SKE library. However, application may use these as well if needed.
+
+
  • SilcSKEDiffieHellmanGroup +
  • silc_ske_group_get_by_number +
  • silc_ske_group_get_by_name +
  • silc_ske_group_free +
  • silc_ske_get_supported_groups +
  • silc_ske_group_get_number +
  • silc_ske_group_get_name + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_groups.xref b/docs/toolkit/manual/silcske_groups.xref new file mode 100644 index 0000000..44452b7 --- /dev/null +++ b/docs/toolkit/manual/silcske_groups.xref @@ -0,0 +1,14 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcske_groups.h" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 0 + "SKE Diffie Hellman Groups" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 1 + "SilcSKEDiffieHellmanGroup" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 5 + "silc_ske_group_get_by_number" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 4 + "silc_ske_group_get_by_name" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 4 + "silc_ske_group_free" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 4 + "silc_ske_get_supported_groups" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 4 + "silc_ske_group_get_number" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 4 + "silc_ske_group_get_name" "/home/priikone/silc1/doc/toolkit/silcske_groups.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcske_i.html b/docs/toolkit/manual/silcske_i.html new file mode 100644 index 0000000..01f46ee --- /dev/null +++ b/docs/toolkit/manual/silcske_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcske_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_i.xref b/docs/toolkit/manual/silcske_i.xref new file mode 100644 index 0000000..c40cd35 --- /dev/null +++ b/docs/toolkit/manual/silcske_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcske_i.h" "/home/priikone/silc1/doc/toolkit/silcske_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcske_payload-SilcSKEKEPayload.html b/docs/toolkit/manual/silcske_payload-SilcSKEKEPayload.html new file mode 100644 index 0000000..cad185c --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-SilcSKEKEPayload.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKEKEPayload

    + + +NAME + +
    
+    typedef struct SilcSKEKEPayloadStruct SilcSKEKEPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Key Exchange Payload and is allocated
+    by silc_ske_payload_ke_decode. It is freed by calling the
+    silc_ske_payload_ke_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload-SilcSKEStartPayload.html b/docs/toolkit/manual/silcske_payload-SilcSKEStartPayload.html new file mode 100644 index 0000000..95e4331 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-SilcSKEStartPayload.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKEStartPayload

    + + +NAME + +
    
+    typedef struct SilcSKEStartPayloadStruct SilcSKEStartPayload;
+
+
    +DESCRIPTION + +
    
+    This context is the actual Key Exchange Start Payload and is allocated
+    by silc_ske_payload_start_decode. It is freed by calling the
+    silc_ske_payload_start_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_decode.html b/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_decode.html new file mode 100644 index 0000000..6399eb2 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_decode.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_payload_ke_decode

    + + +SYNOPSIS + +
    
+    SilcSKEStatus silc_ske_payload_ke_decode(SilcSKE ske,
+                                             SilcBuffer buffer,
+                                             SilcSKEKEPayload
+                                               **return_payload);
+
+
    +DESCRIPTION + +
    
+    Utility function used to decode Key Exchange Payload from the
+    `buffer' data buffer. The decoded payload is returned into the
+    `return_payload' and the caller must free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_encode.html b/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_encode.html new file mode 100644 index 0000000..9cd7e48 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_encode.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_payload_ke_encode

    + + +SYNOPSIS + +
    
+    SilcSKEStatus silc_ske_payload_ke_encode(SilcSKE ske,
+                                             SilcSKEKEPayload payload,
+                                             SilcBuffer *return_buffer);
+
+
    +DESCRIPTION + +
    
+    Utility function used to encode Key Exchange Payload from the
+    `payload' structure. The encoded buffer is returned into the
+    `return_buffer' and the caller must free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_free.html b/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_free.html new file mode 100644 index 0000000..2f89335 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-silc_ske_payload_ke_free.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_payload_ke_free

    + + +SYNOPSIS + +
    
+    void silc_ske_payload_ke_free(SilcSKEKEPayload *payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Key Exchange Payload indicated by `payload'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_decode.html b/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_decode.html new file mode 100644 index 0000000..4a52124 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_decode.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_payload_start_decode

    + + +SYNOPSIS + +
    
+    SilcSKEStatus
+    silc_ske_payload_start_decode(SilcSKE ske,
+                                  SilcBuffer buffer,
+                                  SilcSKEStartPayload *return_payload);
+
+
    +DESCRIPTION + +
    
+    Utility function used to decode Key Exchange Start Payload from the
+    `buffer' data buffer. The decoded payload is returned into the
+    `return_payload' and the caller must free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_encode.html b/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_encode.html new file mode 100644 index 0000000..2e970ee --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_encode.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_payload_start_encode

    + + +SYNOPSIS + +
    
+    SilcSKEStatus silc_ske_payload_start_encode(SilcSKE ske,
+                                                SilcSKEStartPayload payload,
+                                                SilcBuffer *return_buffer);
+
+
    +DESCRIPTION + +
    
+    Utility function used to encode Key Exchange Start Payload from the
+    `payload' structure. The encoded buffer is returned into the
+    `return_buffer' and the caller must free it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_free.html b/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_free.html new file mode 100644 index 0000000..f236352 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload-silc_ske_payload_start_free.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_ske_payload_start_free

    + + +SYNOPSIS + +
    
+    void silc_ske_payload_start_free(SilcSKEStartPayload *payload);
+
+
    +DESCRIPTION + +
    
+    Frees the Key Exchange Start Payload indicated by `payload'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SKE Payloads
    +SilcSKEStartPayload
    +SilcSKEKEPayload
    +silc_ske_payload_start_encode
    +silc_ske_payload_start_decode
    +silc_ske_payload_start_free
    +silc_ske_payload_ke_encode
    +silc_ske_payload_ke_decode
    +silc_ske_payload_ke_free
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload.html b/docs/toolkit/manual/silcske_payload.html new file mode 100644 index 0000000..4d9ff30 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcske_payload.html + + + + +
    + +SKE Payloads
    Header: silcske_payload.h

    + + +DESCRIPTION + +
    
+ This interface defines the implementation of the SKE Payloads, as
+ defined by the SKE protocol. This interface is mainly used by the SKE
+ library, however all structures are public and the interface can be used
+ by the application if needed. Usually application does not need use this
+ interface.
+
+
  • SilcSKEStartPayload +
  • SilcSKEKEPayload +
  • silc_ske_payload_start_encode +
  • silc_ske_payload_start_decode +
  • silc_ske_payload_start_free +
  • silc_ske_payload_ke_encode +
  • silc_ske_payload_ke_decode +
  • silc_ske_payload_ke_free + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcske_payload.xref b/docs/toolkit/manual/silcske_payload.xref new file mode 100644 index 0000000..c88b9f5 --- /dev/null +++ b/docs/toolkit/manual/silcske_payload.xref @@ -0,0 +1,15 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcske_payload.h" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 0 + "SKE Payloads" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 1 + "SilcSKEStartPayload" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 5 + "SilcSKEKEPayload" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 5 + "silc_ske_payload_start_encode" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 4 + "silc_ske_payload_start_decode" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 4 + "silc_ske_payload_start_free" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 4 + "silc_ske_payload_ke_encode" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 4 + "silc_ske_payload_ke_decode" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 4 + "silc_ske_payload_ke_free" "/home/priikone/silc1/doc/toolkit/silcske_payload.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcskelib.html b/docs/toolkit/manual/silcskelib.html new file mode 100644 index 0000000..c4bf19b --- /dev/null +++ b/docs/toolkit/manual/silcskelib.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Key Exchange Library +
    +Directory: lib/silcske/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Key Exchange (SKE) Library, is an implementation of the SKE protocol. +It provides the key exchange protocol for all SILC applications. + +

    + +
  • SILC SKE Interface +
  • SILC Connection Authentication Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-SilcSKR.html b/docs/toolkit/manual/silcskr-SilcSKR.html new file mode 100644 index 0000000..55f4142 --- /dev/null +++ b/docs/toolkit/manual/silcskr-SilcSKR.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKR

    + + +NAME + +
    
+    typedef struct SilcSKRObject *SilcSKR, SilcSKRStruct;
+
+
    +DESCRIPTION + +
    
+    This context is the actual SILC Key Repository and is allocated
+    by silc_skr_alloc (or initialized by silc_skr_init) and given as
+    attribute to all silc_skr_* functions.  It is freed by the
+    silc_skr_free (or uninitialized with silc_skr_uninit) function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-SilcSKRFind.html b/docs/toolkit/manual/silcskr-SilcSKRFind.html new file mode 100644 index 0000000..b5bc043 --- /dev/null +++ b/docs/toolkit/manual/silcskr-SilcSKRFind.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKRFind

    + + +NAME + +
    
+    typedef struct SilcSKRFindStruct *SilcSKRFind
+
+
    +DESCRIPTION + +
    
+    This context contains the search constraints used find keys from the
+    key repository.  It is allocated by silc_skr_find_alloc and freed
+    by silc_skr_find_free.  The context is given as argument to all
+    silc_skr_find* functions.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-SilcSKRFindCallback.html b/docs/toolkit/manual/silcskr-SilcSKRFindCallback.html new file mode 100644 index 0000000..067f98e --- /dev/null +++ b/docs/toolkit/manual/silcskr-SilcSKRFindCallback.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSKRFindCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSKRFindCallback)(SilcSKR skr, SilcSKRFind find,
+                                        SilcSKRStatus status,
+                                        SilcDList keys, void *context);
+
+
    +DESCRIPTION + +
    
+    Callback that is given as argument to silc_skr_find and other find
+    functions.  Returns the results of the finding.  If keys were found
+    the `keys' is non-NULL and receiver must free it with silc_dlist_uninit.
+    Each entry in the `keys' is SilcSKRKey context.  The list `keys' is
+    already at start so calling silc_dlist_start is not necessary when
+    traversing the list from the start.  If the `find' is non-NULL it must
+    be freed with silc_skr_find_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-SilcSKRKey.html b/docs/toolkit/manual/silcskr-SilcSKRKey.html new file mode 100644 index 0000000..e0a98f0 --- /dev/null +++ b/docs/toolkit/manual/silcskr-SilcSKRKey.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcSKRKey

    + + +NAME + +
    
+    typedef struct SilcSKRKeyStruct { ... } *SilcSKRKey;
+
+
    +DESCRIPTION + +
    
+    This context holds the public key, optional public key specific
+    context and public key usage bits.  This context is returned in
+    the SilcSKRFindCallback list.  Each entry in the list is SIlcSKRKey.
+
+
    +SOURCE + +
         */
+    typedef struct SilcSKRKeyStruct {
+      SilcSKRKeyUsage usage;        /* Key usage */
+      SilcPublicKey key;            /* Public key */
+      void *key_context;            /* Optional key specific context */
+    } *SilcSKRKey;
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-SilcSKRKeyUsage.html b/docs/toolkit/manual/silcskr-SilcSKRKeyUsage.html new file mode 100644 index 0000000..8ec32a7 --- /dev/null +++ b/docs/toolkit/manual/silcskr-SilcSKRKeyUsage.html @@ -0,0 +1,258 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSKRKeyUsage

    + + +NAME + +
    
+    typedef enum { ... } SilcSKRKeyUsage;
+
+
    +DESCRIPTION + +
    
+    Indicates the usage of the key.  Keys can be added for different
+    reasons and for different purpose to the repository.  SilcSKRKeyUsage
+    indicates for what reason the key exists in the repository.  The default
+    usage is SILC_SKR_USAGE_ANY and allows any kind of usage for the key.
+    If the usage should be limited then specific usage bitmask can be
+    specified when adding the key.  When searching keys from the
+    repository at least one of the key usage bits must be found in order
+    to find the key.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SKR_USAGE_ANY                   = 0x0000,  /* Any usage */
+      SILC_SKR_USAGE_AUTH                  = 0x0001,  /* Signatures/verification */
+      SILC_SKR_USAGE_ENC                   = 0x0002,  /* Encryption/decryption */
+      SILC_SKR_USAGE_KEY_AGREEMENT         = 0x0004,  /* Key agreement protocol */
+      SILC_SKR_USAGE_IDENTIFICATION        = 0x0008,  /* Identifying key owner */
+      SILC_SKR_USAGE_SERVICE_AUTHORIZATION = 0x0010,  /* Service authorization */
+    
+      /* From 0x0100 reserved for private/application use. */
+    } SilcSKRKeyUsage;
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-SilcSKRStatus.html b/docs/toolkit/manual/silcskr-SilcSKRStatus.html new file mode 100644 index 0000000..d046fb8 --- /dev/null +++ b/docs/toolkit/manual/silcskr-SilcSKRStatus.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSKRStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcSKRStatus;
+
+
    +DESCRIPTION + +
    
+    Indicates the status of the key repository procedures.  This is
+    returned to SilcSKRFindCallback function to indicate the status
+    of the finding.  This is a bitmask, and more than one status may
+    be set at one time.
+
+    If there are no errors only SILC_SKR_OK is set.  If error occurred
+    then at least SILC_SKR_ERROR is set, and possibly other error
+    status also.
+
+    If the SILC_SKR_UNSUPPORTED_TYPE is returned the repository does not
+    support the public key type and it cannot be added to the repository.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SKR_OK                 = 0x00000001, /* All is Ok */
+      SILC_SKR_ERROR              = 0x00000002, /* Generic error status */
+      SILC_SKR_ALREADY_EXIST      = 0x00000004, /* Key already exist */
+      SILC_SKR_NOT_FOUND          = 0x00000008, /* No keys were found */
+      SILC_SKR_NO_MEMORY          = 0x00000010, /* System out of memory */
+      SILC_SKR_UNSUPPORTED_TYPE   = 0x00000020, /* Unsupported PKCS type */
+    } SilcSKRStatus;
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_add_public_key.html b/docs/toolkit/manual/silcskr-silc_skr_add_public_key.html new file mode 100644 index 0000000..38f6ce9 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_add_public_key.html @@ -0,0 +1,266 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_add_public_key

    + + +SYNOPSIS + +
    
+    SilcSKRStatus silc_skr_add_public_key(SilcSKR skr,
+                                          SilcPublicKey public_key,
+                                          SilcSKRKeyUsage usage,
+                                          void *key_context,
+                                          SilcSKRKey *return_key);
+
+
    +DESCRIPTION + +
    
+    Add a public key to repository.  The repository will steal `public_key'
+    and caller must not free it.  The `key_context' is optional key specific
+    context that will be saved in the repository with the key, and can be
+    retrieved with the key.  Public key can be added only once to the
+    repository.  To add same key more than once to repository different
+    `key_context' must be used each time.
+
+    Returns an entry of the added public key in the repository to the
+    `return_key' pointer, if it is non-NULL.  The returned entry remains
+    valid as long as the public key is in the repository, however a
+    reference may be taken with silc_skr_ref_public_key to assure the
+    entry remains valid.
+
+    Returns SILC_SKR_OK if the key was added successfully, and error
+    status if key could not be added, or has been added already.
+
+
    +EXAMPLE + +
    
+    // Add a key to repository
+    if (silc_skr_add_public_key(repository, pubkey, SILC_SKR_USAGE_ANY,
+                                NULL, NULL) != SILC_SKR_OK)
+      goto error;
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_add_public_key_simple.html b/docs/toolkit/manual/silcskr-silc_skr_add_public_key_simple.html new file mode 100644 index 0000000..05d00c0 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_add_public_key_simple.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_add_public_key_simple

    + + +SYNOPSIS + +
    
+    SilcSKRStatus silc_skr_add_public_key_simple(SilcSKR skr,
+                                                 SilcPublicKey public_key,
+                                                 SilcSKRKeyUsage usage,
+                                                 void *key_context,
+                                                 SilcSKRKey *return_key);
+
+
    +DESCRIPTION + +
    
+    Same as silc_skr_add_public_key but adds only the public key, usage
+    bits and key context.  The key cannot be found with any other search
+    constraint except setting the public key, usage bits and/or key
+    context as search constraint.  This function can be used to add the
+    key with as little memory as possible to the repository, and makes
+    it a good way to cheaply store large amounts of public keys.
+
+    Returns an entry of the added public key in the repository to the
+    `return_key' pointer, if it is non-NULL.  The returned entry remains
+    valid as long as the public key is in the repository, however a
+    reference may be taken with silc_skr_ref_public_key to assure the
+    entry remains valid.
+
+    Returns SILC_SKR_OK if the key was added successfully, and error
+    status if key could not be added, or has been added already.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_alloc.html b/docs/toolkit/manual/silcskr-silc_skr_alloc.html new file mode 100644 index 0000000..f72a08b --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_alloc.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_alloc

    + + +SYNOPSIS + +
    
+    SilcSKR silc_skr_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates key repository context.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_del_public_key.html b/docs/toolkit/manual/silcskr-silc_skr_del_public_key.html new file mode 100644 index 0000000..714aa40 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_del_public_key.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_del_public_key

    + + +SYNOPSIS + +
    
+    SilcSKRStatus silc_skr_del_public_key(SilcSKR skr,
+                                          SilcPublicKey public_key,
+                                          void *key_context);
+
+
    +DESCRIPTION + +
    
+    Removes and destroyes the public key from the repository.  The
+    public_key will become invalid after this call returns.
+
+    Returns SILC_SKR_OK if the key was added successfully, and error
+    status if key could not be added, or has been added already.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find.html b/docs/toolkit/manual/silcskr-silc_skr_find.html new file mode 100644 index 0000000..69b14f9 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find.html @@ -0,0 +1,261 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation silc_skr_find(SilcSKR skr, SilcSchedule schedule,
+                                     SilcSKRFind find,
+                                     SilcSKRFindCallback callback,
+                                     void *callback_context);
+
+
    +DESCRIPTION + +
    
+    Finds key(s) from key repository `skr' by the search constraints
+    `find'.  As the finding procedure may be asynchronous this returns
+    SilcAsyncOperation that may be used to control (like abort) the
+    operation.  The `callback' with `callback_context' will be called
+    to return found keys.  If this returns NULL the finding was not
+    asynchronous, and the `callback' has been called already.
+
+
    +EXAMPLE + +
    
+   SilcSKRFind find;
+
+   // Find all SILC public keys originating from Finland
+   find = silc_skr_find_alloc();
+   silc_skr_find_set_pkcs_type(find, SILC_PKCS_SILC);
+   silc_skr_find_set_country(find, "FI");
+
+   // Find
+   silc_skr_find(skr, schedule, find, find_callback, cb_context);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_add_pkcs_type.html b/docs/toolkit/manual/silcskr-silc_skr_find_add_pkcs_type.html new file mode 100644 index 0000000..f8b300a --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_add_pkcs_type.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_add_pkcs_type

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_add_pkcs_type(SilcSKRFind find,
+                                         SilcPKCSType type);
+
+
    +DESCRIPTION + +
    
+    Sets public key cryptosystem type as search constraint.  Will search
+    only for the specific type of key(s).
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_alloc.html b/docs/toolkit/manual/silcskr-silc_skr_find_alloc.html new file mode 100644 index 0000000..178bb14 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_alloc.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_alloc

    + + +SYNOPSIS + +
    
+    SilcSKRFind silc_skr_find_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocates SilcSKRFind context that will hold search constraints used
+    to find specific keys from the repository.  Caller must free the
+    context by calling silc_skr_find_free.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_free.html b/docs/toolkit/manual/silcskr-silc_skr_find_free.html new file mode 100644 index 0000000..d65d3f3 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_free.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_free

    + + +SYNOPSIS + +
    
+    void silc_skr_find_free(SilcSKRFind find);
+
+
    +DESCRIPTION + +
    
+    Free's the search constraints context `find' and all resources in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_context.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_context.html new file mode 100644 index 0000000..7757fd7 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_context.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_context

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_context(SilcSKRFind find, void *context);
+
+
    +DESCRIPTION + +
    
+    Sets public key specific context as search constraint.  This specific
+    context must be associated with the key.  This is the context that
+    was given as argument when adding the key to repository.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_country.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_country.html new file mode 100644 index 0000000..c067511 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_country.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_country

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_country(SilcSKRFind find,
+                                       const char *email);
+
+
    +DESCRIPTION + +
    
+    Sets country as search constraint.  This specific country must be
+    present in the key.
+
+    This may be used with SILC_PKCS_SILC PKCS type only.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_email.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_email.html new file mode 100644 index 0000000..51759b2 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_email.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_email

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_email(SilcSKRFind find,
+                                     const char *email);
+
+
    +DESCRIPTION + +
    
+    Sets email address as search constraint.  This specific address must be
+    present in the key.
+
+    This may be used with SILC_PKCS_SILC PKCS type only.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_host.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_host.html new file mode 100644 index 0000000..040307e --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_host.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_host

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_host(SilcSKRFind find,
+                                    const char *host);
+
+
    +DESCRIPTION + +
    
+    Sets host as search constraint.  This specific host must be
+    present in the key.  The `host' may be a hostname or IP address.
+
+    This may be used with SILC_PKCS_SILC PKCS type only.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_org.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_org.html new file mode 100644 index 0000000..d0f74ea --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_org.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_org

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_org(SilcSKRFind find,
+                                   const char *email);
+
+
    +DESCRIPTION + +
    
+    Sets organization as search constraint.  This specific organization
+    must be present in the key.
+
+    This may be used with SILC_PKCS_SILC PKCS type only.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_public_key.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_public_key.html new file mode 100644 index 0000000..2d09c20 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_public_key.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_public_key

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_public_key(SilcSKRFind find,
+                                          SilcPublicKey public_key);
+
+
    +DESCRIPTION + +
    
+    Sets public key as search constraint.  This specific key must be
+    present in the key.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_realname.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_realname.html new file mode 100644 index 0000000..995dc34 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_realname.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_realname

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_realname(SilcSKRFind find,
+                                        const char *realname);
+
+
    +DESCRIPTION + +
    
+    Sets real name as search constraint.  This specific name must be
+    present in the key.
+
+    This may be used with SILC_PKCS_SILC PKCS type only.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_usage.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_usage.html new file mode 100644 index 0000000..4ddb575 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_usage.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_usage

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_usage(SilcSKRFind find,
+                                     SilcSKRKeyUsage usage);
+
+
    +DESCRIPTION + +
    
+    Sets key usage as search constraint.  At least one of the key usage
+    bits must be present in the key.  This search constraint cannot be
+    used alone to search keys.  At least one other search constraint
+    must also be used.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_find_set_username.html b/docs/toolkit/manual/silcskr-silc_skr_find_set_username.html new file mode 100644 index 0000000..cb9e503 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_find_set_username.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_find_set_username

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_find_set_username(SilcSKRFind find,
+                                        const char *username);
+
+
    +DESCRIPTION + +
    
+    Sets username as search constraint.  This specific username must be
+    present in the key.
+
+    This may be used with SILC_PKCS_SILC PKCS type only.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_free.html b/docs/toolkit/manual/silcskr-silc_skr_free.html new file mode 100644 index 0000000..7222e57 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_free.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_free

    + + +SYNOPSIS + +
    
+    void silc_skr_free(SilcSKR skr);
+
+
    +DESCRIPTION + +
    
+    Free's the key repository context `skr' and all resources in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_init.html b/docs/toolkit/manual/silcskr-silc_skr_init.html new file mode 100644 index 0000000..410e4d1 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_init.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_init

    + + +SYNOPSIS + +
    
+    SilcBool silc_skr_init(SilcSKR skr);
+
+
    +DESCRIPTION + +
    
+    Initializes a pre-allocated SilcSKR context.  This function is
+    equivalent to silc_skr_alloc but takes pre-allocated context as
+    argument.  Returns FALSE if initialization failed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_ref_public_key.html b/docs/toolkit/manual/silcskr-silc_skr_ref_public_key.html new file mode 100644 index 0000000..75e2daf --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_ref_public_key.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_ref_public_key

    + + +SYNOPSIS + +
    
+    void silc_skr_ref_public_key(SilcSKR skr, SilcSKRKey key);
+
+
    +DESCRIPTION + +
    
+    Takes a reference of the public key added to repository indicated
+    by `key'.  The reference must be released by calling the function
+    silc_skr_unref_public_key when it is not needed anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_uninit.html b/docs/toolkit/manual/silcskr-silc_skr_uninit.html new file mode 100644 index 0000000..dd4637a --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_uninit.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_uninit

    + + +SYNOPSIS + +
    
+    void silc_skr_uninit(SilcSKR skr);
+
+
    +DESCRIPTION + +
    
+    Uninitializes a pre-allocated SilcSKR context.  Use this function if
+    you called silc_skr_init.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr-silc_skr_unref_public_key.html b/docs/toolkit/manual/silcskr-silc_skr_unref_public_key.html new file mode 100644 index 0000000..68930c2 --- /dev/null +++ b/docs/toolkit/manual/silcskr-silc_skr_unref_public_key.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_skr_unref_public_key

    + + +SYNOPSIS + +
    
+    void silc_skr_unref_public_key(SilcSKR skr, SilcSKRKey key);
+
+
    +DESCRIPTION + +
    
+    Releases the reference of the public key added to the repository
+    indicated by `key'.  If the released reference is the last reference
+    to the key it will become invalid after this function returns.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Key Repository
    +SilcSKR
    +SilcSKRFind
    +SilcSKRKeyUsage
    +SilcSKRKey
    +SilcSKRStatus
    +SilcSKRFindCallback
    +silc_skr_alloc
    +silc_skr_free
    +silc_skr_init
    +silc_skr_uninit
    +silc_skr_add_public_key
    +silc_skr_add_public_key_simple
    +silc_skr_del_public_key
    +silc_skr_ref_public_key
    +silc_skr_unref_public_key
    +silc_skr_find_alloc
    +silc_skr_find_free
    +silc_skr_find_add_pkcs_type
    +silc_skr_find_set_username
    +silc_skr_find_set_host
    +silc_skr_find_set_realname
    +silc_skr_find_set_email
    +silc_skr_find_set_org
    +silc_skr_find_set_country
    +silc_skr_find_set_public_key
    +silc_skr_find_set_context
    +silc_skr_find_set_usage
    +silc_skr_find
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr.html b/docs/toolkit/manual/silcskr.html new file mode 100644 index 0000000..68a30f0 --- /dev/null +++ b/docs/toolkit/manual/silcskr.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcskr.html + + + + +
    + +SILC Key Repository
    Header: silcskr.h

    + + +DESCRIPTION + +
    
+ SILC Key repository is a generic public key and certificate repository
+ which allows fast and versatile ways to retrieve public keys from the
+ the repository.
+
+ SILC Key Repository is thread safe.  Same key repository context can be
+ safely used in multi threaded environment.
+
+
  • SilcSKR +
  • SilcSKRFind +
  • SilcSKRKeyUsage +
  • SilcSKRKey +
  • SilcSKRStatus +
  • SilcSKRFindCallback +
  • silc_skr_alloc +
  • silc_skr_free +
  • silc_skr_init +
  • silc_skr_uninit +
  • silc_skr_add_public_key +
  • silc_skr_add_public_key_simple +
  • silc_skr_del_public_key +
  • silc_skr_ref_public_key +
  • silc_skr_unref_public_key +
  • silc_skr_find_alloc +
  • silc_skr_find_free +
  • silc_skr_find_add_pkcs_type +
  • silc_skr_find_set_username +
  • silc_skr_find_set_host +
  • silc_skr_find_set_realname +
  • silc_skr_find_set_email +
  • silc_skr_find_set_org +
  • silc_skr_find_set_country +
  • silc_skr_find_set_public_key +
  • silc_skr_find_set_context +
  • silc_skr_find_set_usage +
  • silc_skr_find + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr.xref b/docs/toolkit/manual/silcskr.xref new file mode 100644 index 0000000..37bfcfe --- /dev/null +++ b/docs/toolkit/manual/silcskr.xref @@ -0,0 +1,35 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcskr.h" "/home/priikone/silc1/doc/toolkit/silcskr.html" 0 + "SILC Key Repository" "/home/priikone/silc1/doc/toolkit/silcskr.html" 1 + "SilcSKR" "/home/priikone/silc1/doc/toolkit/silcskr.html" 5 + "SilcSKRFind" "/home/priikone/silc1/doc/toolkit/silcskr.html" 5 + "SilcSKRKeyUsage" "/home/priikone/silc1/doc/toolkit/silcskr.html" 8 + "SilcSKRKey" "/home/priikone/silc1/doc/toolkit/silcskr.html" 5 + "SilcSKRStatus" "/home/priikone/silc1/doc/toolkit/silcskr.html" 8 + "SilcSKRFindCallback" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_alloc" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_free" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_init" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_uninit" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_add_public_key" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_add_public_key_simple" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_del_public_key" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_ref_public_key" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_unref_public_key" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_alloc" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_free" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_add_pkcs_type" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_username" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_host" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_realname" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_email" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_org" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_country" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_public_key" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_context" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find_set_usage" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + "silc_skr_find" "/home/priikone/silc1/doc/toolkit/silcskr.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcskr_i.html b/docs/toolkit/manual/silcskr_i.html new file mode 100644 index 0000000..329b9c1 --- /dev/null +++ b/docs/toolkit/manual/silcskr_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcskr_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcskr_i.xref b/docs/toolkit/manual/silcskr_i.xref new file mode 100644 index 0000000..ad6b51c --- /dev/null +++ b/docs/toolkit/manual/silcskr_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcskr_i.h" "/home/priikone/silc1/doc/toolkit/silcskr_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcskrlib.html b/docs/toolkit/manual/silcskrlib.html new file mode 100644 index 0000000..d07143e --- /dev/null +++ b/docs/toolkit/manual/silcskrlib.html @@ -0,0 +1,215 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Key Repository Library +
    +Directory: lib/silcskr/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Key Repository (SKR) Library can be used to store and retrieve public +keys and certificates. + +

    + +
  • SILC SKR Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsnprintf-silc_asprintf.html b/docs/toolkit/manual/silcsnprintf-silc_asprintf.html new file mode 100644 index 0000000..16cb182 --- /dev/null +++ b/docs/toolkit/manual/silcsnprintf-silc_asprintf.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_asprintf

    + + +SYNOPSIS + +
    
+    int silc_asprintf(char **ptr, const char *format, ...)
+
+
    +DESCRIPTION + +
    
+    Same as silc_snprintf but allocates a string large enough to hold the
+    output including the trailing '\0'.  The caller must free the `ptr'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Snprintf
    +silc_snprintf
    +silc_vsnprintf
    +silc_asprintf
    +silc_vasprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsnprintf-silc_snprintf.html b/docs/toolkit/manual/silcsnprintf-silc_snprintf.html new file mode 100644 index 0000000..5518d54 --- /dev/null +++ b/docs/toolkit/manual/silcsnprintf-silc_snprintf.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_snprintf

    + + +SYNOPSIS + +
    
+    int silc_snprintf(char *str, size_t count, const char *fmt, ...);
+
+
    +DESCRIPTION + +
    
+    Outputs string into `str' of maximum of size `count' including the
+    trailing '\0' according to the `fmt'.  The `fmt' is equivalent to
+    snprintf(3) and printf(3) formatting.  Returns the number of character
+    in `str' or negative value on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Snprintf
    +silc_snprintf
    +silc_vsnprintf
    +silc_asprintf
    +silc_vasprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsnprintf-silc_vasprintf.html b/docs/toolkit/manual/silcsnprintf-silc_vasprintf.html new file mode 100644 index 0000000..99e2cca --- /dev/null +++ b/docs/toolkit/manual/silcsnprintf-silc_vasprintf.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_vasprintf

    + + +SYNOPSIS + +
    
+    int silc_vasprintf(char **ptr, const char *format, va_list ap)
+
+
    +DESCRIPTION + +
    
+    Same as silc_asprintf but takes the argument from the `ap' variable
+    argument list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Snprintf
    +silc_snprintf
    +silc_vsnprintf
    +silc_asprintf
    +silc_vasprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsnprintf-silc_vsnprintf.html b/docs/toolkit/manual/silcsnprintf-silc_vsnprintf.html new file mode 100644 index 0000000..f4be108 --- /dev/null +++ b/docs/toolkit/manual/silcsnprintf-silc_vsnprintf.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_vsnprintf

    + + +SYNOPSIS + +
    
+    int silc_vsnprintf(char *str, size_t count, const char *fmt,
+                       va_list args)
+
+
    +DESCRIPTION + +
    
+    Same as silc_snprintf but takes the argument for the formatting from
+    the `args' variable argument list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +Snprintf
    +silc_snprintf
    +silc_vsnprintf
    +silc_asprintf
    +silc_vasprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsnprintf.html b/docs/toolkit/manual/silcsnprintf.html new file mode 100644 index 0000000..01144d7 --- /dev/null +++ b/docs/toolkit/manual/silcsnprintf.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsnprintf.html + + + + +
    + +Snprintf
    Header: silcsnprintf.h

    + + +DESCRIPTION + +
    
+ Platform independent version of snprintf and other similar string
+ formatting routines.
+
+
  • silc_snprintf +
  • silc_vsnprintf +
  • silc_asprintf +
  • silc_vasprintf + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsnprintf.xref b/docs/toolkit/manual/silcsnprintf.xref new file mode 100644 index 0000000..2f6d1ab --- /dev/null +++ b/docs/toolkit/manual/silcsnprintf.xref @@ -0,0 +1,11 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsnprintf.h" "/home/priikone/silc1/doc/toolkit/silcsnprintf.html" 0 + "Snprintf" "/home/priikone/silc1/doc/toolkit/silcsnprintf.html" 1 + "silc_snprintf" "/home/priikone/silc1/doc/toolkit/silcsnprintf.html" 4 + "silc_vsnprintf" "/home/priikone/silc1/doc/toolkit/silcsnprintf.html" 4 + "silc_asprintf" "/home/priikone/silc1/doc/toolkit/silcsnprintf.html" 4 + "silc_vasprintf" "/home/priikone/silc1/doc/toolkit/silcsnprintf.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcsocketstream-SilcSocketStreamCallback.html b/docs/toolkit/manual/silcsocketstream-SilcSocketStreamCallback.html new file mode 100644 index 0000000..885ddc8 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-SilcSocketStreamCallback.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcSocketStreamCallback

    + + +SYNOPSIS + +
    
+    typedef void (*SilcSocketStreamCallback)(SilcSocketStreamStatus status,
+                                             SilcStream stream,
+                                             void *context);
+
+
    +DESCRIPTION + +
    
+    Callback function of this type is called after the socket stream
+    creation is completed.  If the `stream' is NULL the socket stream could
+    not be created or the socket connection is not otherwise allowed.  The
+    `status' will indicate the error status.  In case error ocurrs the
+    associated socket has already been destroyed.  The `stream' is socket
+    stream representing the socket connection and silc_socket_stream_*
+    functions can be used to access the stream.  All other silc_stream_*
+    functions can also be used to read data, send data, and otherwise
+    handle the stream.
+
+    If the silc_stream_set_notifier is called the stream will be set to
+    non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-SilcSocketStreamStatus.html b/docs/toolkit/manual/silcsocketstream-SilcSocketStreamStatus.html new file mode 100644 index 0000000..bf28d33 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-SilcSocketStreamStatus.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSocketStreamStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcStreamStatus;
+
+
    +DESCRIPTION + +
    
+    Socket Stream status.  This status is returned into the
+    SilcSocketStreamCallback function after the socket stream is
+    created.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_SOCKET_OK,               /* Normal status */
+      SILC_SOCKET_UNKNOWN_IP,       /* Remote does not have IP address */
+      SILC_SOCKET_UNKNOWN_HOST,     /* Remote does not have host name */
+      SILC_SOCKET_NO_MEMORY,        /* System out of memory */
+      SILC_SOCKET_ERROR,            /* Unknown error */
+    } SilcSocketStreamStatus;
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_error.html b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_error.html new file mode 100644 index 0000000..8da93d3 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_error.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_socket_stream_get_error

    + + +SYNOPSIS + +
    
+    int silc_socket_stream_get_error(SilcStream stream);
+
+
    +DESCRIPTION + +
    
+    If error occurred during socket stream operations, this function
+    can be used to retrieve the error number that occurred.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_info.html b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_info.html new file mode 100644 index 0000000..2353314 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_get_info.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_socket_stream_get_info

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_socket_stream_get_info(SilcStream stream,
+                                SilcSocket *sock, const char **hostname,
+                                const char **ip, SilcUInt16 *port);
+
+
    +DESCRIPTION + +
    
+    Returns socket stream information such as the socket, remote hostname,
+    remote IP address and the remote port of the remote socket connection.
+    Return FALSE if these informations are not available.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-silc_socket_stream_is_udp.html b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_is_udp.html new file mode 100644 index 0000000..a9a5721 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_is_udp.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_socket_stream_is_udp

    + + +SYNOPSIS + +
    
+    SilcBool silc_socket_stream_is_udp(SilcStream stream,
+                                       SilcBool *connected);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the `stream' is UDP stream.  If the `connected' pointer
+    is non-NULL it will have indication whether the UDP stream is in
+    connected state.  If it is then packets can be read and written using
+    silc_stream_read and silc_stream_write.  If it is not then packets
+    need to read and written by using silc_net_udp_receive and
+    silc_net_udp_send.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_info.html b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_info.html new file mode 100644 index 0000000..037f902 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_info.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_socket_stream_set_info

    + + +SYNOPSIS + +
    
+    SilcBool
+    silc_socket_stream_set_info(SilcStream stream,
+                                const char *hostname,
+                                const char *ip, SilcUInt16 port);
+
+
    +DESCRIPTION + +
    
+    Use this function to set the hostname, IP address and remote port
+    information to the socket stream indicated by `stream' if you did not
+    perform lookup in the silc_socket_tcp_stream_create.  This is not
+    mandatory but if you would like to associate the information with the
+    stream use this function.  If the lookup was performed when creating
+    the stream then calling this function is not necessary.  Use the
+    function silc_socket_stream_get_info to get the information from the
+    stream.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_qos.html b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_qos.html new file mode 100644 index 0000000..9782ee8 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-silc_socket_stream_set_qos.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_socket_stream_set_qos

    + + +SYNOPSIS + +
    
+    SilcBool silc_socket_stream_set_qos(SilcStream stream,
+                                        SilcUInt32 read_rate,
+                                        SilcUInt32 read_limit_bytes,
+                                        SilcUInt32 limit_sec,
+                                        SilcUInt32 limit_usec)
+
+
    +DESCRIPTION + +
    
+    Sets a "Quality of Service" settings for socket stream `stream'.
+    The `read_rate' specifies the maximum read operations per second.
+    If more read operations are executed the limit will be applied for
+    the reading.  The `read_limit_bytes' specifies the maximum data
+    that is read.  It is guaranteed that silc_stream_read  never returns
+    more than `read_limit_bytes' of data.  The `limit_sec' and `limit_usec'
+    specifies the time limit that is applied if `read_rate' and/or
+    `read_limit_bytes' is reached.  If all arguments except `stream'
+    are zero this resets the QoS from the socket stream, all QoS for
+    this socket stream that may be pending will be cancelled.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-silc_socket_tcp_stream_create.html b/docs/toolkit/manual/silcsocketstream-silc_socket_tcp_stream_create.html new file mode 100644 index 0000000..6a3a0f0 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-silc_socket_tcp_stream_create.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_socket_tcp_stream_create

    + + +SYNOPSIS + +
    
+    SilcAsyncOperation
+    silc_socket_tcp_stream_create(SilcSocket sock, SilcBool lookup,
+                                  SilcBool require_fqdn,
+                                  SilcSchedule schedule,
+                                  SilcSocketStreamCallback callback,
+                                  void *context);
+
+
    +DESCRIPTION + +
    
+    Creates TCP socket stream of the TCP connection indicated by `sock'.
+    The stream can be destroyed by calling the silc_stream_destroy.  Data
+    can be sent and received from the stream by calling silc_stream_write
+    and silc_stream_read.  The creation process is asynchronous since
+    socket connection information, such as hostname and IP address are
+    resolved, so SilcAsyncOperation is returned which can be used to cancel
+    the creation process.  The `callback' will be called to return the
+    created socket stream.
+
+    If the `lookup' is TRUE then this will perform IP and hostname lookup
+    for the socket.  If the `require_fqdn' is TRUE then the socket must
+    have valid hostname and IP address, otherwise the stream creation will
+    fail.  If it is FALSE then only valid IP address is required.  Note that,
+    if the `lookup' is FALSE then the hostname, IP and port information
+    will not be available from the socket stream.  In that case this will
+    also return NULL as the `callback' is called immediately.
+
+    If the silc_stream_set_notifier is called the stream is set to
+    non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream-silc_socket_udp_stream_create.html b/docs/toolkit/manual/silcsocketstream-silc_socket_udp_stream_create.html new file mode 100644 index 0000000..f80fa3a --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream-silc_socket_udp_stream_create.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_socket_udp_stream_create

    + + +SYNOPSIS + +
    
+    SilcStream silc_socket_udp_stream_create(SilcSocket sock,
+                                             SilcBool ipv6,
+                                             SilcBool connected,
+                                             SilcSchedule schedule);
+
+
    +DESCRIPTION + +
    
+    Creates UDP socket stream of the UDP connection indicated by `sock'.
+    The stream can be destroyed by calling the silc_stream_destroy.
+    The `connected' defines whether the socket is in connected or in
+    connectionless state.
+
+    Note that, UDP packets may be read only through the notifier
+    callback (see silc_stream_set_notifier), when SILC_STREAM_CAN_READ
+    is returned to the callback.  Because of this the notifier callback
+    must be set.
+
+    Note that, UDP packet sending using silc_stream_write and receiving
+    with silc_stream_read works only if the `sock' is a UDP socket in a
+    connected state.  In connectionless state sending packets with
+    silc_stream_write is possible only if the remote address and port
+    has been set with silc_socket_stream_set_info.  If it is not set
+    in connectionless state packets may be sent only by using the
+    silc_net_udp_send function.  In connectionless state packets may be
+    received only by using silc_net_udp_receive.
+
+    This function returns the created SilcStream or NULL on error.
+
+    If the silc_stream_set_notifier is called the stream is set to
+    non-blocking mode.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Socket Stream Interface
    +SilcSocketStreamStatus
    +SilcSocketStreamCallback
    +silc_socket_tcp_stream_create
    +silc_socket_udp_stream_create
    +silc_socket_stream_is_udp
    +silc_socket_stream_get_info
    +silc_socket_stream_set_info
    +silc_socket_stream_get_error
    +silc_socket_stream_set_qos
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream.html b/docs/toolkit/manual/silcsocketstream.html new file mode 100644 index 0000000..0ea9f85 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsocketstream.html + + + + +
    + +SILC Socket Stream Interface
    Header: silcsocketstream.h

    + + +DESCRIPTION + +
    
+ Implementation of SILC Socket Stream.  SILC Socket Stream can be used
+ read data from and write data to a socket connection.  The SILC Socket
+ Stream provides also Quality of Service (QoS) support that can be used
+ to control the throughput of the stream.  It also supports both TCP and
+ UDP, and IPv4 and IPv6.
+
+ SILC Socket Stream is not thread-safe.  If the same socket stream must be
+ used in multithreaded environment concurrency control must be employed.
+
+
  • SilcSocketStreamStatus +
  • SilcSocketStreamCallback +
  • silc_socket_tcp_stream_create +
  • silc_socket_udp_stream_create +
  • silc_socket_stream_is_udp +
  • silc_socket_stream_get_info +
  • silc_socket_stream_set_info +
  • silc_socket_stream_get_error +
  • silc_socket_stream_set_qos + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream.xref b/docs/toolkit/manual/silcsocketstream.xref new file mode 100644 index 0000000..774e10b --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream.xref @@ -0,0 +1,16 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsocketstream.h" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 0 + "SILC Socket Stream Interface" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 1 + "SilcSocketStreamStatus" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 8 + "SilcSocketStreamCallback" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + "silc_socket_tcp_stream_create" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + "silc_socket_udp_stream_create" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + "silc_socket_stream_is_udp" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + "silc_socket_stream_get_info" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + "silc_socket_stream_set_info" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + "silc_socket_stream_get_error" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + "silc_socket_stream_set_qos" "/home/priikone/silc1/doc/toolkit/silcsocketstream.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcsocketstream_i.html b/docs/toolkit/manual/silcsocketstream_i.html new file mode 100644 index 0000000..1b8b36c --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsocketstream_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsocketstream_i.xref b/docs/toolkit/manual/silcsocketstream_i.xref new file mode 100644 index 0000000..499d251 --- /dev/null +++ b/docs/toolkit/manual/silcsocketstream_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsocketstream_i.h" "/home/priikone/silc1/doc/toolkit/silcsocketstream_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcstack-SilcStack.html b/docs/toolkit/manual/silcstack-SilcStack.html new file mode 100644 index 0000000..7f3e1bc --- /dev/null +++ b/docs/toolkit/manual/silcstack-SilcStack.html @@ -0,0 +1,220 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcStack

    + + +NAME + +
    
+    typedef struct SilcStackStruct *SilcStack;
+
+
    +DESCRIPTION + +
    
+    This context represents the stack and it is allocated by
+    silc_stack_alloc and is destroyed with silc_stack_free functions.
+    The context is given as argument to all routines that use this
+    stack allocation library.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcStack Interface
    +SilcStack
    +SilcStackFrame
    +silc_stack_alloc
    +silc_stack_free
    +silc_stack_push
    +silc_stack_pop
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack-SilcStackFrame.html b/docs/toolkit/manual/silcstack-SilcStackFrame.html new file mode 100644 index 0000000..1a54086 --- /dev/null +++ b/docs/toolkit/manual/silcstack-SilcStackFrame.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcStackFrame

    + + +NAME + +
    
+    typedef struct SilcStackFrameStruct SilcStackFrame;
+
+
    +DESCRIPTION + +
    
+    Static stack frame context that optionally can be used as stack
+    frame in SilcStack.  By default silc_stack_push use pre-allocated
+    stack frame (or allocates new one if all frames are reserved), but
+    user may also use statically allocated SilcStackFrame instead.  This
+    is recommended when using SilcStack in recursive routine and the
+    recursion may become deep.  Using static frame assures that during
+    recursion frames never run out and silc_stack_push never allocates
+    any memory.  In other normal usage statically allocated SilcStackFrame
+    is not needed, unless performance is critical.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcStack Interface
    +SilcStack
    +SilcStackFrame
    +silc_stack_alloc
    +silc_stack_free
    +silc_stack_push
    +silc_stack_pop
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack-silc_stack_alloc.html b/docs/toolkit/manual/silcstack-silc_stack_alloc.html new file mode 100644 index 0000000..beb8b55 --- /dev/null +++ b/docs/toolkit/manual/silcstack-silc_stack_alloc.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stack_alloc

    + + +SYNOPSIS + +
    
+    SilcStack silc_stack_alloc(SilcUInt32 stack_size);
+
+
    +DESCRIPTION + +
    
+    Allocates new data stack that can be used as stack for fast memory
+    allocation by various routines.  Returns the pointer to the stack
+    that must be freed with silc_stack_free function when it is not
+    needed anymore.  If the `stack_size' is zero (0) by default a
+    1 kilobyte (1024 bytes) stack is allocated.  If the `stack_size'
+    is non-zero the byte value must be multiple by 8.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcStack Interface
    +SilcStack
    +SilcStackFrame
    +silc_stack_alloc
    +silc_stack_free
    +silc_stack_push
    +silc_stack_pop
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack-silc_stack_free.html b/docs/toolkit/manual/silcstack-silc_stack_free.html new file mode 100644 index 0000000..d074bf7 --- /dev/null +++ b/docs/toolkit/manual/silcstack-silc_stack_free.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stack_free

    + + +SYNOPSIS + +
    
+    void silc_stack_free(SilcStack stack);
+
+
    +DESCRIPTION + +
    
+    Frees the data stack context.  The stack cannot be used anymore after
+    this and all allocated memory are freed.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcStack Interface
    +SilcStack
    +SilcStackFrame
    +silc_stack_alloc
    +silc_stack_free
    +silc_stack_push
    +silc_stack_pop
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack-silc_stack_pop.html b/docs/toolkit/manual/silcstack-silc_stack_pop.html new file mode 100644 index 0000000..5c178c9 --- /dev/null +++ b/docs/toolkit/manual/silcstack-silc_stack_pop.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stack_pop

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_stack_pop(SilcStack stack);
+
+
    +DESCRIPTION + +
    
+    Pop the top of the stack upwards which reveals the previous stack frame
+    and becomes the top of the stack.  After popping, memory allocated in
+    the old frame is freed.  For each silc_stack_push call there must be
+    silc_stack_pop call to free all memory (in reality any memory is not
+    freed but within the stack it is).  This returns the stack pointer of
+    old frame after popping and caller may check that it is same as
+    returned by the silc_stack_push.  If it they differ, some routine
+    has called silc_stack_push but has not called silc_stack_pop, or
+    silc_stack_pop has been called too many times.  Application should
+    treat this as a fatal error, as it is a bug in the application code.
+
+    If `stack' is NULL this call has no effect.
+
+
    +EXAMPLE + +
    
+    This example saves the stack pointer which is checked when popping
+    the current stack frame.  If the stack pointer differs then someone
+    has pushed the stack frame but forgot to pop it (or has called it
+    too many times).
+
+    sp = silc_stack_push(stack, NULL);
+    silc_foo_parse_packet(packet, stack);
+    if (silc_stack_pop(stack) != sp)
+      fatal("corrupted stack");
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcStack Interface
    +SilcStack
    +SilcStackFrame
    +silc_stack_alloc
    +silc_stack_free
    +silc_stack_push
    +silc_stack_pop
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack-silc_stack_push.html b/docs/toolkit/manual/silcstack-silc_stack_push.html new file mode 100644 index 0000000..934feff --- /dev/null +++ b/docs/toolkit/manual/silcstack-silc_stack_push.html @@ -0,0 +1,269 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stack_push

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_stack_push(SilcStack stack, SilcStackFrame *frame);
+
+
    +DESCRIPTION + +
    
+    Push the top of the stack down which becomes the new top of the stack.
+    For every silc_stack_push call there must be silc_stack_pop call.  All
+    allocations between these two calls will be done from the top of the
+    stack and all allocated memory is freed after the next silc_stack_pop
+    is called.  This returns so called stack pointer for the new stack
+    frame, which the caller may use to check that all calls to
+    silc_stack_pop has been made.  This call may do a small memory
+    allocation in some cases, but usually it does not allocate any memory.
+    If this returns zero (0) the system is out of memory.
+
+    If the `frame' is non-NULL then that SilcStackFrame is used as
+    stack frame.  Usually `frame' is set to NULL by user.  Statically
+    allocated SilcStackFrame should be used when using silc_stack_push
+    in recursive function and the recursion may become deep.  In this
+    case using statically allocated SilcStackFrame is recommended since
+    it assures that frames never run out and silc_stack_push never
+    allocates any memory.  If your routine is not recursive then
+    setting `frame' to NULL is recommended, unless performance is
+    critical.
+
+    This function is used when a routine is doing frequent allocations
+    from the stack.  If the stack is not pushed and later popped all
+    allocations are made from the stack and the stack eventually runs out
+    (it gets enlarged by normal memory allocation).  By pushing and then
+    later popping the frequent allocations does not consume the stack.
+
+    If `stack' is NULL this call has no effect.
+
+
    +EXAMPLE + +
    
+    All memory allocations in silc_foo_parse_packet will be done in
+    a fresh stack frame and that data is freed after the parsing is
+    completed.
+
+    silc_stack_push(stack, NULL);
+    silc_foo_parse_packet(packet, stack);
+    silc_stack_pop(stack);
+
+    Another example with recursion and using statically allocated
+    SilcStackFrame.  After popping the statically allocated frame can
+    be reused if necessary.
+
+    void silc_foo_this_function(SilcStack stack)
+    {
+      SilcStackFrame frame;
+      ...
+      silc_stack_push(stack, &frame);
+      silc_foo_this_function(stack);   // Call recursively
+      silc_stack_pop(stack);
+      ...
+    }
+
+
    +



    +
    +     		+ + + + +
    +
    + +SilcStack Interface
    +SilcStack
    +SilcStackFrame
    +silc_stack_alloc
    +silc_stack_free
    +silc_stack_push
    +silc_stack_pop
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack.html b/docs/toolkit/manual/silcstack.html new file mode 100644 index 0000000..4bdc356 --- /dev/null +++ b/docs/toolkit/manual/silcstack.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcstack.html + + + + +
    + +SilcStack Interface
    Header: silcstack.h

    + + +DESCRIPTION + +
    
+ Implementation of data stack which can be used to allocate memory from
+ the stack.  Basicly SilcStack is a pre-allocated memory pool system
+ which allows fast memory allocation for routines and applications that
+ frequently allocate small amounts of memory.  Other advantage of this
+ system is that there are no memory leaks, as long as the stack is
+ freed eventually.  Since the stack is usually allocated only once this
+ is not an issue.
+
+ SilcStack can be used to allocate both aligned and unaligned memory so
+ it is suitable for allocating structures and is optimal for allocating
+ strings and data buffers.  SilcStack also supports stack pushing and
+ popping allowing to push the stack, allocate memory and then pop it
+ to free the allocated memory.  The freeing does not actually do any
+ real memory freeing so it is optimized for performance.
+
+ A basic set of utility functions are provided for application that wish
+ to use the SilcStack as their primary memory allocation source.  The
+ following functions support SilcStack:
+
+ silc_smalloc, silc_smalloc_ua, silc_scalloc, silc_srealloc, silc_smemdup,
+ silc_sstrdup, silc_buffer_salloc, silc_buffer_salloc_size,
+ silc_buffer_srealloc, silc_buffer_srealloc_size, silc_buffer_scopy,
+ silc_buffer_sclone, silc_buffer_sformat, silc_buffer_sformat_vp,
+ silc_buffer_sstrformat, silc_buffer_senlarge, silc_mp_sinit
+
+ The data stack is not thread-safe.  If the same stack context must be
+ used in multithreaded environment concurrency control must be employed.
+ Each thread should allocate their own SilcStack.
+
+
  • SilcStack +
  • SilcStackFrame +
  • silc_stack_alloc +
  • silc_stack_free +
  • silc_stack_push +
  • silc_stack_pop + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack.xref b/docs/toolkit/manual/silcstack.xref new file mode 100644 index 0000000..71ef432 --- /dev/null +++ b/docs/toolkit/manual/silcstack.xref @@ -0,0 +1,13 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcstack.h" "/home/priikone/silc1/doc/toolkit/silcstack.html" 0 + "SilcStack Interface" "/home/priikone/silc1/doc/toolkit/silcstack.html" 1 + "SilcStack" "/home/priikone/silc1/doc/toolkit/silcstack.html" 5 + "SilcStackFrame" "/home/priikone/silc1/doc/toolkit/silcstack.html" 5 + "silc_stack_alloc" "/home/priikone/silc1/doc/toolkit/silcstack.html" 4 + "silc_stack_free" "/home/priikone/silc1/doc/toolkit/silcstack.html" 4 + "silc_stack_push" "/home/priikone/silc1/doc/toolkit/silcstack.html" 4 + "silc_stack_pop" "/home/priikone/silc1/doc/toolkit/silcstack.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcstack_i.html b/docs/toolkit/manual/silcstack_i.html new file mode 100644 index 0000000..1de25ab --- /dev/null +++ b/docs/toolkit/manual/silcstack_i.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcstack_i.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstack_i.xref b/docs/toolkit/manual/silcstack_i.xref new file mode 100644 index 0000000..55063c7 --- /dev/null +++ b/docs/toolkit/manual/silcstack_i.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcstack_i.h" "/home/priikone/silc1/doc/toolkit/silcstack_i.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcstatus-SilcStatus.html b/docs/toolkit/manual/silcstatus-SilcStatus.html new file mode 100644 index 0000000..52b651e --- /dev/null +++ b/docs/toolkit/manual/silcstatus-SilcStatus.html @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcStatus

    + + +NAME + +
    
+    typedef SilcUInt8 SilcStatus
+
+
    +DESCRIPTION + +
    
+    The SilcStatus type definition and the status defines.  The
+    server returns a status in each Command Payload indicating
+    the status of the command.  The server can also return this
+    inside SILC_NOTIFY_TYPE_ERROR notify type.
+
+
    +SOURCE + +
        typedef SilcUInt8 SilcStatus;
+    
+    /* Command Status messages */
+    #define SILC_STATUS_OK                      0
+    #define SILC_STATUS_LIST_START              1
+    #define SILC_STATUS_LIST_ITEM               2
+    #define SILC_STATUS_LIST_END                3
+    #define SILC_STATUS_ERR_NO_SUCH_NICK        10
+    #define SILC_STATUS_ERR_NO_SUCH_CHANNEL     11
+    #define SILC_STATUS_ERR_NO_SUCH_SERVER      12
+    #define SILC_STATUS_ERR_INCOMPLETE_INFORMATION    13
+    #define SILC_STATUS_ERR_NO_RECIPIENT        14
+    #define SILC_STATUS_ERR_UNKNOWN_COMMAND     15
+    #define SILC_STATUS_ERR_WILDCARDS           16
+    #define SILC_STATUS_ERR_NO_CLIENT_ID        17
+    #define SILC_STATUS_ERR_NO_CHANNEL_ID       18
+    #define SILC_STATUS_ERR_NO_SERVER_ID        19
+    #define SILC_STATUS_ERR_BAD_CLIENT_ID       20
+    #define SILC_STATUS_ERR_BAD_CHANNEL_ID      21
+    #define SILC_STATUS_ERR_NO_SUCH_CLIENT_ID   22
+    #define SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID  23
+    #define SILC_STATUS_ERR_NICKNAME_IN_USE     24
+    #define SILC_STATUS_ERR_NOT_ON_CHANNEL      25
+    #define SILC_STATUS_ERR_USER_NOT_ON_CHANNEL 26
+    #define SILC_STATUS_ERR_USER_ON_CHANNEL     27
+    #define SILC_STATUS_ERR_NOT_REGISTERED      28
+    #define SILC_STATUS_ERR_NOT_ENOUGH_PARAMS   29
+    #define SILC_STATUS_ERR_TOO_MANY_PARAMS     30
+    #define SILC_STATUS_ERR_PERM_DENIED         31
+    #define SILC_STATUS_ERR_BANNED_FROM_SERVER  32
+    #define SILC_STATUS_ERR_BAD_PASSWORD        33
+    #define SILC_STATUS_ERR_CHANNEL_IS_FULL     34
+    #define SILC_STATUS_ERR_NOT_INVITED         35
+    #define SILC_STATUS_ERR_BANNED_FROM_CHANNEL 36
+    #define SILC_STATUS_ERR_UNKNOWN_MODE        37
+    #define SILC_STATUS_ERR_NOT_YOU             38
+    #define SILC_STATUS_ERR_NO_CHANNEL_PRIV     39
+    #define SILC_STATUS_ERR_NO_CHANNEL_FOPRIV   40
+    #define SILC_STATUS_ERR_NO_SERVER_PRIV      41
+    #define SILC_STATUS_ERR_NO_ROUTER_PRIV      42
+    #define SILC_STATUS_ERR_BAD_NICKNAME        43
+    #define SILC_STATUS_ERR_BAD_CHANNEL         44
+    #define SILC_STATUS_ERR_AUTH_FAILED         45
+    #define SILC_STATUS_ERR_UNKNOWN_ALGORITHM   46
+    #define SILC_STATUS_ERR_NO_SUCH_SERVER_ID   47
+    #define SILC_STATUS_ERR_RESOURCE_LIMIT      48
+    #define SILC_STATUS_ERR_NO_SUCH_SERVICE     49
+    #define SILC_STATUS_ERR_NOT_AUTHENTICATED   50
+    #define SILC_STATUS_ERR_BAD_SERVER_ID       51
+    #define SILC_STATUS_ERR_KEY_EXCHANGE_FAILED 52
+    #define SILC_STATUS_ERR_BAD_VERSION         53
+    #define SILC_STATUS_ERR_TIMEDOUT            54
+    #define SILC_STATUS_ERR_UNSUPPORTED_PUBLIC_KEY    55
+    #define SILC_STATUS_ERR_OPERATION_ALLOWED   56
+    #define SILC_STATUS_ERR_BAD_SERVER          57
+    #define SILC_STATUS_ERR_BAD_USERNAME        58
+    #define SILC_STATUS_ERR_NO_SUCH_PUBLIC_KEY  59
    +



    +
    +     		+ + + + +
    +
    + +SILC Status Types
    +SilcStatus
    +silc_status_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstatus-silc_status_get_args.html b/docs/toolkit/manual/silcstatus-silc_status_get_args.html new file mode 100644 index 0000000..999f6c9 --- /dev/null +++ b/docs/toolkit/manual/silcstatus-silc_status_get_args.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_status_get_args

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_status_get_args(SilcStatus status,
+                                    SilcArgumentPayload args,
+                                    void **ret_arg1, **ret_arg2);
+
+
    +DESCRIPTION + +
    
+    Parses and returns the arguments from the `args' by the status type
+    indicated by `status'.  Returns the number of arguments (0, 1 or 2)
+    parsed.  The caller must free with silc_free the returned arguments.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Status Types
    +SilcStatus
    +silc_status_get_args
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstatus.html b/docs/toolkit/manual/silcstatus.html new file mode 100644 index 0000000..56b1a50 --- /dev/null +++ b/docs/toolkit/manual/silcstatus.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcstatus.html + + + + +
    + +SILC Status Types
    Header: silcstatus.h

    + + +DESCRIPTION + +
    
+ This header includes the SILC Status Types that are used with
+ command replies and with notify packets.  With command reply packets
+ they indicate whether error occurred during procesing of the command
+ and indicate the error type.  With notify type they always indicate
+ which error occurred.  Both command reply and notify type share the
+ same status types.
+
+
  • SilcStatus +
  • silc_status_get_args + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstatus.xref b/docs/toolkit/manual/silcstatus.xref new file mode 100644 index 0000000..5164ff7 --- /dev/null +++ b/docs/toolkit/manual/silcstatus.xref @@ -0,0 +1,9 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcstatus.h" "/home/priikone/silc1/doc/toolkit/silcstatus.html" 0 + "SILC Status Types" "/home/priikone/silc1/doc/toolkit/silcstatus.html" 1 + "SilcStatus" "/home/priikone/silc1/doc/toolkit/silcstatus.html" 8 + "silc_status_get_args" "/home/priikone/silc1/doc/toolkit/silcstatus.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcstatus_args.html b/docs/toolkit/manual/silcstatus_args.html new file mode 100644 index 0000000..483f9fe --- /dev/null +++ b/docs/toolkit/manual/silcstatus_args.html @@ -0,0 +1,685 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    +SilcStatus Arguments + +
     
    +The SilcStatus is used to indicate +a status (usually error status) of command execution and command reply +status. It is also used to deliver disconnection status when server +disconnects client from the server. For application it is mainly important +in case of `command_reply' client operation, where the SilcStatus indicates +the error status of the command that was executed. If error occurred the +arguments returned by the `command_reply' are then dependent of the SilcStatus +type instead of the SilcCommand +arguments. + +
     
    +This documents describes how the application should interpret the SilcStatus +type in the `command_reply' client operation to be able to handle all +error conditions properly. Any status type can be returned for any +SilcCommand. For this reason application should be able to handle any +error with any command. + + +
     
     
    +Error Status In command_reply Client Operation + +
     
    +When error occurs in execution of a command the `command_reply' client +operation is called with error status. In this case the 'success' +argument of the client operation is set to FALSE, to indicate that command +execution failed, and the 'status' argument indicates the error. +If the 'status' argument is SILC_STATUS_OK then error did not occur and the +arguments are as described in SilcCommand +arguments. + +
     
    +Application should handle the error status arguments by the SilcStatus +type for example in a switch statement. The SilcStatus values +are defined in lib/silccore/silcstatus.h header file. A short example. + +
     
    + +  switch(status)
    +    {
    +    case SILC_STATUS_ERR_NO_SUCH_NICK:
    +    ...
    +    nick = va_arg(va, char *);
    +    ...
    +    break;
    +    case SILC_STATUS_ERR_NO_SUCH_CHANNEL:
    +    ...
    +    break;
    +    case SILC_STATUS_ERR_NO_SUCH_SERVER:
    +    ...
    +    break;
    +    ...
    +    default:
    +    break;
    +    } +     + + +
     
     
    +Arguments + +
     
    +The following table describes all status values and arguments that the client +library sends in the 'command_reply' client operation to the application +in case of error. All arguments listed below are usually valid when +returned by the library. However applicationn must be able to handle that +any of those arguments may be NULL. + +
     
    +The 'command_reply' arguments in case of error are as follows: + +
     
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDescriptionError Arguments
    SILC_STATUS_OK +No error. +N/A +
    SILC_STATUS_ERR_NO_SUCH_NICK +Requested nickname does not exist. Argument is the unknown name. +const char *nickname +
    SILC_STATUS_ERR_NO_SUCH_CHANNEL +The requested channel does not exist. Argument is the unknown name. +const char *channel_name +
    SILC_STATUS_ERR_NO_SUCH_SERVER +The requested server does not exist. Argument is the unknown name. +const char *server_name +
    SILC_STATUS_ERR_NO_RECIPIENT +Command required recipient but none was provided. No arguments returned. +N/A +
    SILC_STATUS_ERR_UNKNOWN_COMMAND +Command sent to server is unknown or unsupported by the server. No +arguments returned. +N/A +
    SILC_STATUS_ERR_WILDCARDS +Wildcards were provided by they were not permitted. No arguments returned. +N/A +
    SILC_STATUS_ERR_NO_CLIENT_ID +Client ID was expected as command parameter but was not found. No +arguments returned. +N/A +
    SILC_STATUS_ERR_NO_CHANNEL_ID +Channel ID was expected as command parameter but was not found. No +arguments returned. +N/A +
    SILC_STATUS_ERR_NO_SERVER_ID +Server ID was expected as command parameter but was not found. No +arguments returned. +N/A +
    SILC_STATUS_ERR_BAD_CLIENT_ID +Client ID provided was malformed. Returns the malformed ID. +const SilcClientID *client_id +
    SILC_STATUS_ERR_BAD_CHANNEL_ID +Channel ID provided was malformed. Returns the malformed ID. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_BAD_SERVER_ID +Server ID provided was malformed. Returns the malformed ID. +const SilcServerID *server_id +
    SILC_STATUS_ERR_NO_SUCH_CLIENT_ID +Client ID provided does not exist. The unknown ID is returned. +const SilcClientID *client_id +
    SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID +Channel ID provided does not exist. The unknown ID is returned. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_NO_SUCH_SERVER_ID +Server ID provided does not exist. The unknown ID is returned. +const SilcServerID *server_id +
    SILC_STATUS_ERR_NOT_ON_CHANNEL +The command required for you to be on channel but you were not. +The channel ID is returned. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_USER_NOT_ON_CHANNEL +The requested target client is not on requested channel. Returns the +target client ID and channel ID. +const SilcClientID *client_id, +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_USER_ON_CHANNEL +User were invited on channel they already are on. Returns the +target client ID and channel ID. +const SilcClientID *client_id, +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_NOT_REGISTERED +User executed command that requires the client to be registered on the +server before it may be executed. No arguments returned. +N/A +
    SILC_STATUS_ERR_NOT_ENOUGH_PARAMS +Command required more parameters than provided. No arguments returned. +N/A +
    SILC_STATUS_ERR_TOO_MANY_PARAMS +Too many parameters provided for the command. No arguments returned. +N/A +
    SILC_STATUS_ERR_PERM_DENIED +Generic permission denied error status, to indicat disallowed access. +No arguments returned. +N/A +
    SILC_STATUS_ERR_BAD_PASSWORD +Password provided for channel were not accepted. Returns the channel ID. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_CHANNEL_IS_FULL +The channel is full and client cannot join the channel. Returns the +channel ID. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_NOT_INVITED +The channel is invite only channel and client has not been invited. +Returns the channel ID. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_BANNED_FROM_CHANNEL +The client has been banned from the channel. Returns the channel ID. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_UNKNOWN_MODE +Mode provided by the client was unknown to or unsupported by the server. +No arguments returned. +N/A +
    SILC_STATUS_ERR_NOT_YOU +User tried to change someone else's mode which is not allowed. +No arguments returned. +N/A +
    SILC_STATUS_ERR_NO_CHANNEL_PRIV +Command may be executed only by channel operator. The next argument is +the channel ID. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_NO_CHANNEL_FOPRIV +Command may be executed only by channel founder. The next argument is +the channel ID. +const SilcChannelID *channel_id +
    SILC_STATUS_ERR_NO_SERVER_PRIV +Command may be executed only by server operator. No arguments returned. +N/A +
    SILC_STATUS_ERR_NO_ROUTER_PRIV +Command may be executed only by router (SILC) operator. No arguments returned. +N/A +
    SILC_STATUS_ERR_BAD_NICKNAME +Nickname requested contained illegal characters or was malformed. No +arguments returned. +N/A +
    SILC_STATUS_ERR_BAD_CHANNEL +Channel name requested contained illegal characters or was malformed. No +arguments returned. +N/A +
    SILC_STATUS_ERR_AUTH_FAILED +The authentication data (passphrase or digital signature) sent as argument +was wrong and thus authentication failed. No arguments returned. +N/A +
    SILC_STATUS_ERR_UNKNOWN_ALGORITHM +The server does not support requested algorithm. Returns the unknown +algorithm. +const char *alg_name +
    SILC_STATUS_ERR_RESOURCE_LIMIT +Server cannot or will not accept the action due to resource limitations. +No arguments returned. +N/A +
    SILC_STATUS_ERR_NO_SUCH_SERVICE +Requestes service identifier is unknown. Returns the unknown service +identifier. +const char *service_identifier +
    SILC_STATUS_ERR_TIMEDOUT +Operation (command execution) or service request timed out, and thus was +not processed. This usually happens due to network failure between servers +and routers in the network. No arguments returned. +N/A +
    SILC_STATUS_ERR_UNSUPPORTED_PUBLIC_KEY +The public key or certificate type is not supported in ths implementation. +No arguments returned. +N/A +
    SILC_STATUS_ERR_OPERATION_ALLOWED +A operation, for example a command, is not allowed or it's execution is +not allowed. No arguments returned. +N/A +
    + +
     
    +SILC protocol defines some additional status types but those status +types are not returned in `command_reply' client operation. Only +the status types listed above are delivered to application. +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-SilcStream.html b/docs/toolkit/manual/silcstream-SilcStream.html new file mode 100644 index 0000000..c79ef4c --- /dev/null +++ b/docs/toolkit/manual/silcstream-SilcStream.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcStream

    + + +NAME + +
    
+    typedef void *SilcStream;
+
+
    +DESCRIPTION + +
    
+    Abstact stream context representing any stream.  All streams are using
+    this abstraction so that the stream can be accessed using the standard
+    silc_stream_* functions.  All streams are destroyed by calling the
+    silc_stream_destroy function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-SilcStreamNotifier.html b/docs/toolkit/manual/silcstream-SilcStreamNotifier.html new file mode 100644 index 0000000..e310067 --- /dev/null +++ b/docs/toolkit/manual/silcstream-SilcStreamNotifier.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcStreamNotifier

    + + +SYNOPSIS + +
    
+    typedef void (*SilcStreamNotifier)(SilcStream stream,
+                                       SilcStreamStatus status,
+                                       void *context);
+
+
    +DESCRIPTION + +
    
+    A callback of this type is called as stream notifier to notify of a
+    certain action taken over the stream.  This is called to notify for
+    example that data is ready for reading, or writing or that end of
+    stream occurred.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-SilcStreamOps.html b/docs/toolkit/manual/silcstream-SilcStreamOps.html new file mode 100644 index 0000000..c8dab9b --- /dev/null +++ b/docs/toolkit/manual/silcstream-SilcStreamOps.html @@ -0,0 +1,273 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcStreamOps

    + + +NAME + +
    
+    typedef struct { ... } SilcStreamOps;
+
+
    +DESCRIPTION + +
    
+    SILC Stream operations structure.  This structure includes callback
+    functions to the actual stream implementation.  Any stream that
+    use SILC Stream abstraction must fill this structure with the actual
+    stream implementation.
+
+    Each stream implementation MUST set this structure as the first field
+    in their stream structure.  As it is that structure that is passed
+    to the silc_stream_* routines, the SILC Stream API expects that the
+    SilcStream context starts with this structure.
+
+
    +EXAMPLE + +
    
+    typedef struct {
+      const SilcStreamOps *ops;
+      ... other stuff ...
+    } *SilcFooStream;
+
+    SilcFooStream foo;
+    silc_stream_write(foo, data, data_len);
+
+
    +SOURCE + +
        typedef struct {
+      /* This is called to read data from the stream.  This is called when
+         silc_stream_read function was called. */
+      int (*read)(SilcStream stream, unsigned char *buf, SilcUInt32 buf_len);
+    
+      /* This is called when writing data to the stream.  This is called when
+         silc_stream_write function was called. */
+      int (*write)(SilcStream stream, const unsigned char *data,
+                   SilcUInt32 data_len);
+    
+      /* This is called to close the stream.  This is called when the
+         silc_stream_close function was called. */
+      SilcBool (*close)(SilcStream stream);
+    
+      /* This is called to destroy the stream.  This is called when the
+         silc_stream_destroy function was called. */
+      void (*destroy)(SilcStream stream);
+    
+      /* This is called to set a notifier callback to the stream and schedule
+         the stream.  Stream should not be scheduled before calling this
+         function.  If stream does not need scheduler then the scheduler can
+         be ignored.  This is called when silc_stream_set_notifier was called.
+         Returns FALSE if the stream could not be scheduled. */
+      SilcBool (*notifier)(SilcStream stream, SilcSchedule schedule,
+                           SilcStreamNotifier callback, void *context);
+    
+      /* This is called to return the associated scheduler, if set.  This is
+         called when silc_stream_get_schedule was called. */
+      SilcSchedule (*get_schedule)(SilcStream stream);
+    } SilcStreamOps;
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-SilcStreamStatus.html b/docs/toolkit/manual/silcstream-SilcStreamStatus.html new file mode 100644 index 0000000..44fbdef --- /dev/null +++ b/docs/toolkit/manual/silcstream-SilcStreamStatus.html @@ -0,0 +1,234 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcStreamStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcStreamStatus;
+
+
    +DESCRIPTION + +
    
+    Stream status.  This status is returned into the SilcStreamNotifier
+    callback function to indicate the status of the stream at a given
+    moment.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_STREAM_CAN_READ,         /* Data available for reading */
+      SILC_STREAM_CAN_WRITE,        /* Stream ready for writing */
+      SILC_STREAM_EOS,              /* End of stream */
+      SILC_STREAM_CLOSED,           /* Stream is closed */
+      SILC_STREAM_INVALID,          /* Stream is invalid */
+      SILC_STREAM_NO_MEMORY,        /* System out of memory */
+      SILC_STREAM_ERROR,            /* Unknown error */
+    } SilcStreamStatus;
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-silc_stream_close.html b/docs/toolkit/manual/silcstream-silc_stream_close.html new file mode 100644 index 0000000..4a2a97a --- /dev/null +++ b/docs/toolkit/manual/silcstream-silc_stream_close.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stream_close

    + + +SYNOPSIS + +
    
+    SilcBool silc_stream_close(SilcStream stream);
+
+
    +DESCRIPTION + +
    
+    Closes the stream indicated by `stream'.  No data can be read or written
+    to the stream after calling this function.  Return TRUE if the stream
+    could be closed.  If action is taken on closed stream the notifier
+    callback may be called with an error status.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-silc_stream_destroy.html b/docs/toolkit/manual/silcstream-silc_stream_destroy.html new file mode 100644 index 0000000..364f47b --- /dev/null +++ b/docs/toolkit/manual/silcstream-silc_stream_destroy.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stream_destroy

    + + +SYNOPSIS + +
    
+    void silc_stream_destroy(SilcStream stream);
+
+
    +DESCRIPTION + +
    
+    Destroy the stream indicated by `stream'.  The `stream' will become
+    invalid after this function returns.  All streams are destroyed by
+    calling this function.  The silc_stream_close should be called
+    before calling this function.  However, if it is not called this
+    function will call it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-silc_stream_get_schedule.html b/docs/toolkit/manual/silcstream-silc_stream_get_schedule.html new file mode 100644 index 0000000..502bff9 --- /dev/null +++ b/docs/toolkit/manual/silcstream-silc_stream_get_schedule.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stream_get_schedule

    + + +SYNOPSIS + +
    
+    SilcSchedule silc_stream_get_schedule(SilcStream stream);
+
+
    +DESCRIPTION + +
    
+    Returns the scheduler that has been associated with the `stream', or
+    NULL if one has not been set for the `stream'.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-silc_stream_read.html b/docs/toolkit/manual/silcstream-silc_stream_read.html new file mode 100644 index 0000000..abca2e5 --- /dev/null +++ b/docs/toolkit/manual/silcstream-silc_stream_read.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stream_read

    + + +SYNOPSIS + +
    
+    int silc_stream_read(SilcStream stream, unsigned char *buf,
+                         SilcUInt32 buf_len);
+
+
    +DESCRIPTION + +
    
+    Reads data from the stream indicated by `stream' into the data buffer
+    indicated by `buf' which is size of `buf_len'.  This returns the amount
+    of data read, zero (0) if end of stream occurred, -1 if data could
+    not be read at this moment, or -2 if error occurred.  If -1 is returned
+    the notifier callback will later be called with SILC_STREAM_CAN_READ
+    status when stream is again ready for reading.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-silc_stream_set_notifier.html b/docs/toolkit/manual/silcstream-silc_stream_set_notifier.html new file mode 100644 index 0000000..634e699 --- /dev/null +++ b/docs/toolkit/manual/silcstream-silc_stream_set_notifier.html @@ -0,0 +1,236 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stream_set_notifier

    + + +SYNOPSIS + +
    
+    SilcBool silc_stream_set_notifier(SilcStream stream,
+                                      SilcSchedule schedule,
+                                      SilcStreamNotifier notifier,
+                                      void *context);
+
+
    +DESCRIPTION + +
    
+    Schedule `stream' for stream events.  Set the `notifier' callback to
+    be called when some event takes place on the stream.  The event will
+    be delievered to the `notifier' callback with the `context'.  It is
+    called for example when data is available for reading or writing, or
+    if an error occurs.  This can be called at any time for valid stream.
+    This call will also set the `stream' into non-blocking mode.
+
+    If `notifier' is set to NULL no callback will be called for the stream,
+    and the stream is not scheduled anymore.
+
+    This function returns FALSE if the `schedule' was provided and the
+    stream could not be scheduled.  The actual API for `stream' may provide
+    access to the actual error information.  Returns TRUE on success.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream-silc_stream_write.html b/docs/toolkit/manual/silcstream-silc_stream_write.html new file mode 100644 index 0000000..3822b46 --- /dev/null +++ b/docs/toolkit/manual/silcstream-silc_stream_write.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stream_write

    + + +SYNOPSIS + +
    
+    int silc_stream_write(SilcStream stream, const unsigned char *data,
+                          SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Writes `data_len' bytes of data to the stream indicated by `stream' from
+    data buffer indicated by `data'.  Returns the amount of data written,
+    zero (0) if end of stream occurred, -1 if data could not be written
+    at this moment, or -2 if error occurred.  If -1 is returned the
+    notifier callback will later be called with SILC_STREAM_CAN_WRITE
+    status when stream is again ready for writing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stream Interface
    +SilcStream
    +SilcStreamStatus
    +SilcStreamNotifier
    +SilcStreamOps
    +silc_stream_read
    +silc_stream_write
    +silc_stream_close
    +silc_stream_destroy
    +silc_stream_set_notifier
    +silc_stream_get_schedule
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream.html b/docs/toolkit/manual/silcstream.html new file mode 100644 index 0000000..6d3064c --- /dev/null +++ b/docs/toolkit/manual/silcstream.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcstream.html + + + + +
    + +SILC Stream Interface
    Header: silcstream.h

    + + +DESCRIPTION + +
    
+ SILC Stream API is a generic representation of a stream.  A common API
+ is defined that can be used to read from and write to the stream.  Any
+ other stream API derived from this API can use this same interface for
+ reading and writing.
+
+ Note that stream implementations usually are not thread-safe.  Always
+ verify whether a stream implementation is thread-safe by checking their
+ corresponding documentation.
+
+
  • SilcStream +
  • SilcStreamStatus +
  • SilcStreamNotifier +
  • SilcStreamOps +
  • silc_stream_read +
  • silc_stream_write +
  • silc_stream_close +
  • silc_stream_destroy +
  • silc_stream_set_notifier +
  • silc_stream_get_schedule + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstream.xref b/docs/toolkit/manual/silcstream.xref new file mode 100644 index 0000000..c96d829 --- /dev/null +++ b/docs/toolkit/manual/silcstream.xref @@ -0,0 +1,17 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcstream.h" "/home/priikone/silc1/doc/toolkit/silcstream.html" 0 + "SILC Stream Interface" "/home/priikone/silc1/doc/toolkit/silcstream.html" 1 + "SilcStream" "/home/priikone/silc1/doc/toolkit/silcstream.html" 5 + "SilcStreamStatus" "/home/priikone/silc1/doc/toolkit/silcstream.html" 8 + "SilcStreamNotifier" "/home/priikone/silc1/doc/toolkit/silcstream.html" 4 + "SilcStreamOps" "/home/priikone/silc1/doc/toolkit/silcstream.html" 5 + "silc_stream_read" "/home/priikone/silc1/doc/toolkit/silcstream.html" 4 + "silc_stream_write" "/home/priikone/silc1/doc/toolkit/silcstream.html" 4 + "silc_stream_close" "/home/priikone/silc1/doc/toolkit/silcstream.html" 4 + "silc_stream_destroy" "/home/priikone/silc1/doc/toolkit/silcstream.html" 4 + "silc_stream_set_notifier" "/home/priikone/silc1/doc/toolkit/silcstream.html" 4 + "silc_stream_get_schedule" "/home/priikone/silc1/doc/toolkit/silcstream.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcstringprep-SilcStringprepFlags.html b/docs/toolkit/manual/silcstringprep-SilcStringprepFlags.html new file mode 100644 index 0000000..d80bf13 --- /dev/null +++ b/docs/toolkit/manual/silcstringprep-SilcStringprepFlags.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcStringprepFlags

    + + +NAME + +
    
+    typedef enum { ... } SilcStringprepFlags;
+
+
    +DESCRIPTION + +
    
+    Flags that change how the strings are prepared with silc_stringprep.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_STRINGPREP_NONE               = 0x00,  /* No flags */
+      SILC_STRINGPREP_ALLOW_UNASSIGNED   = 0x01,  /* Allow unassigned characters
+                                                     without returning error. */
+    } SilcStringprepFlags;
    +



    +
    +     		+ + + + +
    +
    + +SILC Stringprep
    +SilcStringprepStatus
    +SilcStringprepFlags
    +silc_stringprep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstringprep-SilcStringprepStatus.html b/docs/toolkit/manual/silcstringprep-SilcStringprepStatus.html new file mode 100644 index 0000000..efca448 --- /dev/null +++ b/docs/toolkit/manual/silcstringprep-SilcStringprepStatus.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcStringprepStatus

    + + +NAME + +
    
+    typedef enum { ... } SilcStringprepStatus;
+
+
    +DESCRIPTION + +
    
+    Status and errors returned by silc_stringprep.
+
+
    +SOURCE + +
        typedef enum {
+      SILC_STRINGPREP_OK,                     /* Preparation success */
+      SILC_STRINGPREP_ERR_UNASSIGNED,         /* Contains unassigned characters */
+      SILC_STRINGPREP_ERR_PROHIBITED,         /* Contains prohibited characters */
+      SILC_STRINGPREP_ERR_BIDI_PROHIBITED,    /* BIDI contains prohibited chars */
+      SILC_STRINGPREP_ERR_BIDI_RAL_WITH_L,    /* BIDI has both R/AL and L */
+      SILC_STRINGPREP_ERR_BIDI_RAL,           /* BIDI has R/AL but not as leading
+                                                 and/or trailing character. */
+      SILC_STRINGPREP_ERR_OUT_OF_MEMORY,      /* System out of memory */
+      SILC_STRINGPREP_ERR_ENCODING,           /* Character encoding error */
+      SILC_STRINGPREP_ERR_UNSUP_ENCODING,     /* Unsupported character encoding  */
+      SILC_STRINGPREP_ERR_UNSUP_PROFILE,      /* Unsupported profile */
+      SILC_STRINGPREP_ERR,                    /* Unknown error */
+    } SilcStringprepStatus;
    +



    +
    +     		+ + + + +
    +
    + +SILC Stringprep
    +SilcStringprepStatus
    +SilcStringprepFlags
    +silc_stringprep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstringprep-silc_stringprep.html b/docs/toolkit/manual/silcstringprep-silc_stringprep.html new file mode 100644 index 0000000..bf1baef --- /dev/null +++ b/docs/toolkit/manual/silcstringprep-silc_stringprep.html @@ -0,0 +1,245 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_stringprep

    + + +SYNOPSIS + +
    
+    SilcStringprepStatus
+    silc_stringprep(const unsigned char *bin, SilcUInt32 bin_len,
+                    SilcStringEncoding bin_encoding,
+                    const char *profile_name,
+                    SilcStringprepFlags flags,
+                    unsigned char **out, SilcUInt32 *out_len,
+                    SilcStringEncoding out_encoding);
+
+
    +DESCRIPTION + +
    
+    Prepares the input string 'bin' of length 'bin_len' of encoding
+    'bin_encoding' according to the stringrep profile 'profile_name'.
+    Returns the prepared and allocated string into 'out'.  The 'out_len'
+    indicates the length of the prepared string.  This returns the
+    SilcStringprepStatus which indicates the status of the preparation.
+    For example, if the input string contains prohibited characters
+    (according to the used profile) this function will return error.
+    The 'flags' however can be used to modify the behavior of this
+    function.  Caller must free the returned 'out' string.
+
+    The output string will be encoded into the character encoding
+    defined by the 'out_encoding'.  This allows caller to have for
+    example the input string as locale specific string and output string
+    as UTF-8 encoded string.
+
+    If the 'out' is NULL this function merely performs the preparation
+    process, but does not return anything.  In this case this function
+    could be used to for example verify that an input string that ought
+    to have been prepared correctly was done so.
+
+    Available profile names:
+
+      SILC_IDENTIFIER_PREP            Prepares SILC identifier strings
+      SILC_IDENTIFIER_CH_PREP         Prepares SILC channel name strings
+      SILC_IDENTIFIERC_PREP           Casefolds identifier strings
+      SILC_CASEFOLD_PREP              Casefolding and normalizing
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Stringprep
    +SilcStringprepStatus
    +SilcStringprepFlags
    +silc_stringprep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstringprep.html b/docs/toolkit/manual/silcstringprep.html new file mode 100644 index 0000000..a67e76b --- /dev/null +++ b/docs/toolkit/manual/silcstringprep.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcstringprep.html + + + + +
    + +SILC Stringprep
    Header: silcstringprep.h

    + + +DESCRIPTION + +
    
+ Interface for the stringprep (RFC3454) standard, that is used to prepare
+ strings for internationalization.  The interface can be used to prepare
+ strings according to various stringprep profiles.  The profiles defines
+ what characters the strings may contain, what characters are prohibited
+ and how the strings are prepared.
+
+
  • SilcStringprepStatus +
  • SilcStringprepFlags +
  • silc_stringprep + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstringprep.xref b/docs/toolkit/manual/silcstringprep.xref new file mode 100644 index 0000000..0ce7fe4 --- /dev/null +++ b/docs/toolkit/manual/silcstringprep.xref @@ -0,0 +1,10 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcstringprep.h" "/home/priikone/silc1/doc/toolkit/silcstringprep.html" 0 + "SILC Stringprep" "/home/priikone/silc1/doc/toolkit/silcstringprep.html" 1 + "SilcStringprepStatus" "/home/priikone/silc1/doc/toolkit/silcstringprep.html" 8 + "SilcStringprepFlags" "/home/priikone/silc1/doc/toolkit/silcstringprep.html" 8 + "silc_stringprep" "/home/priikone/silc1/doc/toolkit/silcstringprep.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcstrutil-SilcStringEncoding.html b/docs/toolkit/manual/silcstrutil-SilcStringEncoding.html new file mode 100644 index 0000000..183d8ac --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-SilcStringEncoding.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcStringEncoding

    + + +NAME + +
    
+    typedef enum { ... } SilcStringEncoding;
+
+
    +DESCRIPTION + +
    
+    String encoding definitions used with various string manipulation
+    routines.  By default, applications are suggested to use
+    SILC_STRING_LOCALE since it encodes and decodes correctly according
+    to local system language and character set (locale).
+
+
    +SOURCE + +
        typedef enum {
+      SILC_STRING_ASCII         = 0,  /* Any 8 bit ASCII encoding (default) */
+      SILC_STRING_ASCII_ESC     = 1,  /* 7 bit ASCII (>0x7f escaped) */
+      SILC_STRING_BMP           = 2,  /* 16 bit, UCS-2, BMP, ISO/IEC 10646 */
+      SILC_STRING_BMP_LSB       = 3,  /* BMP, least significant byte first */
+      SILC_STRING_UNIVERSAL     = 4,  /* 32 bit, UCS-4, Universal, ISO/IEC 10646 */
+      SILC_STRING_UNIVERSAL_LSB = 5,  /* Universal, least significant byte first */
+      SILC_STRING_LOCALE        = 6,  /* A locale specific conversion on
+                                         those platforms that support iconv().
+                                         Fallback is SILC_STRING_ASCII. */
+      SILC_STRING_UTF8          = 7,  /* UTF-8 encoding */
+      SILC_STRING_PRINTABLE     = 8,  /* Printable ASCII (no escaping) */
+      SILC_STRING_VISIBLE       = 9,  /* Visible ASCII string */
+      SILC_STRING_TELETEX       = 10, /* Teletex ASCII string */
+      SILC_STRING_NUMERICAL     = 11, /* Numerical ASCII string (digits) */
+      SILC_STRING_LDAP_DN       = 12, /* Strings for LDAP DNs, RFC 2253 */
+      SILC_STRING_UTF8_ESCAPE   = 12, /* Escaped UTF-8 as defined in RFC 2253 */
+    
+      SILC_STRING_LANGUAGE      = 6,  /* _Deprecated_, use SILC_STRING_LOCALE. */
+    } SilcStringEncoding;
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_base64_encode.html b/docs/toolkit/manual/silcstrutil-silc_base64_encode.html new file mode 100644 index 0000000..fbf7878 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_base64_encode.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_base64_encode

    + + +SYNOPSIS + +
    
+    char *silc_base64_encode(unsigned char *data, SilcUInt32 len);
+
+
    +DESCRIPTION + +
    
+    Encodes data into Base 64 (PEM) encoding. Returns NULL terminated
+    Base 64 encoded data string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_base64_encode_file.html b/docs/toolkit/manual/silcstrutil-silc_base64_encode_file.html new file mode 100644 index 0000000..6ca7acc --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_base64_encode_file.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_base64_encode_file

    + + +SYNOPSIS + +
    
+    char *silc_base64_encode_file(unsigned char *data, SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Same as silc_base64_encode() but puts newline ('\n') every 72
+    characters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_base_decode.html b/docs/toolkit/manual/silcstrutil-silc_base_decode.html new file mode 100644 index 0000000..8ddb6d6 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_base_decode.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_base_decode

    + + +SYNOPSIS + +
    
+    unsigned char *silc_base_decode(unsigned char *base64,
+                                    SilcUInt32 base64_len,
+                                    SilcUInt32 *ret_len);
+
+
    +DESCRIPTION + +
    
+    Decodes Base 64 (PEM) into data. Returns the decoded data.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_string_compare.html b/docs/toolkit/manual/silcstrutil-silc_string_compare.html new file mode 100644 index 0000000..37d3682 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_string_compare.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_string_compare

    + + +SYNOPSIS + +
    
+    int silc_string_compare(char *string1, char *string2);
+
+
    +DESCRIPTION + +
    
+    Compares two strings. Strings may include wildcards '*' and '?'.
+    Returns TRUE if strings match.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_string_match.html b/docs/toolkit/manual/silcstrutil-silc_string_match.html new file mode 100644 index 0000000..9d39dd4 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_string_match.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_string_match

    + + +SYNOPSIS + +
    
+    int silc_string_match(const char *string1, const char *string2);
+
+
    +DESCRIPTION + +
    
+    Do regex match to the two strings `string1' and `string2'. If the
+    `string2' matches the `string1' this returns TRUE.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_string_regex_match.html b/docs/toolkit/manual/silcstrutil-silc_string_regex_match.html new file mode 100644 index 0000000..734ab7c --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_string_regex_match.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_string_regex_match

    + + +SYNOPSIS + +
    
+    int silc_string_regex_match(const char *regex, const char *string);
+
+
    +DESCRIPTION + +
    
+    Matches the two strings and returns TRUE if the strings match.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_string_regexify.html b/docs/toolkit/manual/silcstrutil-silc_string_regexify.html new file mode 100644 index 0000000..bfd7013 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_string_regexify.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_string_regexify

    + + +SYNOPSIS + +
    
+    char *silc_string_regexify(const char *string);
+
+
    +DESCRIPTION + +
    
+    Inspects the `string' for wildcards and returns regex string that can
+    be used by the GNU regex library. A comma (`,') in the `string' means
+    that the string is list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_string_split.html b/docs/toolkit/manual/silcstrutil-silc_string_split.html new file mode 100644 index 0000000..badd319 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_string_split.html @@ -0,0 +1,225 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_string_split

    + + +SYNOPSIS + +
    
+    char **silc_string_split(const char *string, char ch, int *ret_count);
+
+
    +DESCRIPTION + +
    
+    Splits a `string' that has a separator `ch' into an array of strings
+    and returns the array.  The `ret_count' will contain the number of
+    strings in the array.  Caller must free the strings and the array.
+    Returns NULL on error.  If the string does not have `ch' separator
+    this returns the `string' in the array.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil-silc_strncat.html b/docs/toolkit/manual/silcstrutil-silc_strncat.html new file mode 100644 index 0000000..1a3b53f --- /dev/null +++ b/docs/toolkit/manual/silcstrutil-silc_strncat.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_strncat

    + + +SYNOPSIS + +
    
+    char *silc_strncat(char *dest, SilcUInt32 dest_size,
+                       const char *src, SilcUInt32 src_len);
+
+
    +DESCRIPTION + +
    
+    Concatenates the `src' into `dest'.  If `src_len' is more than the
+    size of the `dest' (minus NULL at the end) the `src' will be
+    truncated to fit.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC String Utilities
    +SilcStringEncoding
    +silc_base64_encode
    +silc_base64_encode_file
    +silc_base_decode
    +silc_strncat
    +silc_string_regexify
    +silc_string_regex_match
    +silc_string_match
    +silc_string_compare
    +silc_string_split
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil.html b/docs/toolkit/manual/silcstrutil.html new file mode 100644 index 0000000..d068e06 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcstrutil.html + + + + +
    + +SILC String Utilities
    Header: silcstrutil.h

    + + +DESCRIPTION + +
    
+ String manipulation utility routines.  These routines provides
+ various helper functions for encoding, decoding and otherwise
+ managing strings.
+
+
  • SilcStringEncoding +
  • silc_base64_encode +
  • silc_base64_encode_file +
  • silc_base_decode +
  • silc_strncat +
  • silc_string_regexify +
  • silc_string_regex_match +
  • silc_string_match +
  • silc_string_compare +
  • silc_string_split + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcstrutil.xref b/docs/toolkit/manual/silcstrutil.xref new file mode 100644 index 0000000..f568759 --- /dev/null +++ b/docs/toolkit/manual/silcstrutil.xref @@ -0,0 +1,17 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcstrutil.h" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 0 + "SILC String Utilities" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 1 + "SilcStringEncoding" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 8 + "silc_base64_encode" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_base64_encode_file" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_base_decode" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_strncat" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_string_regexify" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_string_regex_match" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_string_match" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_string_compare" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + "silc_string_split" "/home/priikone/silc1/doc/toolkit/silcstrutil.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcsymbiansocketstream.html b/docs/toolkit/manual/silcsymbiansocketstream.html new file mode 100644 index 0000000..490d057 --- /dev/null +++ b/docs/toolkit/manual/silcsymbiansocketstream.html @@ -0,0 +1,203 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcsymbiansocketstream.html + + + + +
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcsymbiansocketstream.xref b/docs/toolkit/manual/silcsymbiansocketstream.xref new file mode 100644 index 0000000..c92996d --- /dev/null +++ b/docs/toolkit/manual/silcsymbiansocketstream.xref @@ -0,0 +1,6 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcsymbiansocketstream.h" "/home/priikone/silc1/doc/toolkit/silcsymbiansocketstream.html" 0 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcthread-SilcThread.html b/docs/toolkit/manual/silcthread-SilcThread.html new file mode 100644 index 0000000..5195f59 --- /dev/null +++ b/docs/toolkit/manual/silcthread-SilcThread.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcThread

    + + +NAME + +
    
+    typedef struct SilcThreadStruct *SilcThread;
+
+
    +DESCRIPTION + +
    
+    This context is the actual SILC Thread and is returned by
+    the silc_thread_create functions, and given as arguments to
+    some of the silc_thread_* functions. This context and its
+    resources are released automatically when the thread exits.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Thread Interface
    +SilcThread
    +SilcThreadStart
    +silc_thread_create
    +silc_thread_exit
    +silc_thread_self
    +silc_thread_wait
    +silc_thread_yield
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread-SilcThreadStart.html b/docs/toolkit/manual/silcthread-SilcThreadStart.html new file mode 100644 index 0000000..3846c97 --- /dev/null +++ b/docs/toolkit/manual/silcthread-SilcThreadStart.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function SilcThreadStart

    + + +SYNOPSIS + +
    
+    typedef void *(*SilcThreadStart)(void *context);
+
+
    +DESCRIPTION + +
    
+    A callback function that is called when the thread is created
+    by the silc_thread_create function.  This returns the return value
+    of the thread. If another thread is waiting this thread's
+    destruction with silc_thread_wait the returned value is passed
+    to that thread. The thread is destroyed when this function
+    returns.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Thread Interface
    +SilcThread
    +SilcThreadStart
    +silc_thread_create
    +silc_thread_exit
    +silc_thread_self
    +silc_thread_wait
    +silc_thread_yield
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread-silc_thread_create.html b/docs/toolkit/manual/silcthread-silc_thread_create.html new file mode 100644 index 0000000..ba6c9de --- /dev/null +++ b/docs/toolkit/manual/silcthread-silc_thread_create.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_thread_create

    + + +SYNOPSIS + +
    
+    SilcThread silc_thread_create(SilcThreadStart start_func,
+                                  void *context, SilcBool waitable);
+
    +DESCRIPTION + +
    
+    Creates a new thread. The `start_func' with `context' will be
+    called if the thread was created. This function returns a pointer
+    to the thread or NULL if the thread could not be created.  All
+    resources of the returned pointer is freed automatically when the
+    thread exits.
+
+    If the `waitable' is set to TRUE then another thread can wait
+    this thread's destruction with silc_thread_wait. If it is set to
+    FALSE the thread is not waitable.
+
+
    +NOTES + +
    
+    If the `waitable' is TRUE the thread's resources are not freed
+    when it exits until another thread has issued silc_thread_wait.
+    If the `waitable' is TRUE then another thread must always issue
+    silc_thread_wait to avoid memory leaks.
+
+    On Symbian Cleanup Stack is created and new Active Scheduler is
+    installed automatically for the created thread.  The thread also
+    shares heap with the calling thread.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Thread Interface
    +SilcThread
    +SilcThreadStart
    +silc_thread_create
    +silc_thread_exit
    +silc_thread_self
    +silc_thread_wait
    +silc_thread_yield
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread-silc_thread_exit.html b/docs/toolkit/manual/silcthread-silc_thread_exit.html new file mode 100644 index 0000000..3dd1939 --- /dev/null +++ b/docs/toolkit/manual/silcthread-silc_thread_exit.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_thread_exit

    + + +SYNOPSIS + +
    
+    void silc_thread_exit(void *exit_value);
+
+
    +DESCRIPTION + +
    
+    Exits the current thread. This can be called to explicitly exit
+    the thread with `exit_value'. Another way to exit (destroy) the
+    current thread is to return from the SilcThreadStart function
+    with exit value. The exit value is passed to another thread if it
+    is waiting it with silc_thread_wait function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Thread Interface
    +SilcThread
    +SilcThreadStart
    +silc_thread_create
    +silc_thread_exit
    +silc_thread_self
    +silc_thread_wait
    +silc_thread_yield
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread-silc_thread_self.html b/docs/toolkit/manual/silcthread-silc_thread_self.html new file mode 100644 index 0000000..1faf0a9 --- /dev/null +++ b/docs/toolkit/manual/silcthread-silc_thread_self.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_thread_self

    + + +SYNOPSIS + +
    
+    SilcThread silc_thread_self(void);
+
+
    +DESCRIPTION + +
    
+    Returns a pointer to the current thread.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Thread Interface
    +SilcThread
    +SilcThreadStart
    +silc_thread_create
    +silc_thread_exit
    +silc_thread_self
    +silc_thread_wait
    +silc_thread_yield
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread-silc_thread_wait.html b/docs/toolkit/manual/silcthread-silc_thread_wait.html new file mode 100644 index 0000000..74f4bbd --- /dev/null +++ b/docs/toolkit/manual/silcthread-silc_thread_wait.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_thread_wait

    + + +SYNOPSIS + +
    
+    SilcBool silc_thread_wait(SilcThread thread, void **exit_value);
+
+
    +DESCRIPTION + +
    
+    Waits until the thread indicated by `thread' finishes. This blocks
+    the execution of the current thread. The thread is finished if it
+    calls silc_thread_exit or is destroyed naturally. When the thread
+    exits its exit value is saved to `exit_value' and TRUE is returned.
+    If the `thread' is not waitable this will return immediately with
+    FALSE value.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Thread Interface
    +SilcThread
    +SilcThreadStart
    +silc_thread_create
    +silc_thread_exit
    +silc_thread_self
    +silc_thread_wait
    +silc_thread_yield
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread-silc_thread_yield.html b/docs/toolkit/manual/silcthread-silc_thread_yield.html new file mode 100644 index 0000000..522b7f7 --- /dev/null +++ b/docs/toolkit/manual/silcthread-silc_thread_yield.html @@ -0,0 +1,219 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_thread_yield

    + + +SYNOPSIS + +
    
+    void silc_thread_yield(void);
+
+
    +DESCRIPTION + +
    
+    Yield the processor.  The calling thread will yield the processor and
+    give execution time for other threads, until its turn comes up again.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Thread Interface
    +SilcThread
    +SilcThreadStart
    +silc_thread_create
    +silc_thread_exit
    +silc_thread_self
    +silc_thread_wait
    +silc_thread_yield
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread.html b/docs/toolkit/manual/silcthread.html new file mode 100644 index 0000000..71cb38e --- /dev/null +++ b/docs/toolkit/manual/silcthread.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcthread.html + + + + +
    + +SILC Thread Interface
    Header: silcthread.h

    + + +DESCRIPTION + +
    
+ Interface for SILC Thread implementation. This is platform independent
+ interface of threads for applications that need concurrent execution
+ with the application's main thread. The threads created with this
+ interface executes concurrently with the calling thread.
+
+
  • SilcThread +
  • SilcThreadStart +
  • silc_thread_create +
  • silc_thread_exit +
  • silc_thread_self +
  • silc_thread_wait +
  • silc_thread_yield + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcthread.xref b/docs/toolkit/manual/silcthread.xref new file mode 100644 index 0000000..cd8ded4 --- /dev/null +++ b/docs/toolkit/manual/silcthread.xref @@ -0,0 +1,14 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcthread.h" "/home/priikone/silc1/doc/toolkit/silcthread.html" 0 + "SILC Thread Interface" "/home/priikone/silc1/doc/toolkit/silcthread.html" 1 + "SilcThread" "/home/priikone/silc1/doc/toolkit/silcthread.html" 5 + "SilcThreadStart" "/home/priikone/silc1/doc/toolkit/silcthread.html" 4 + "silc_thread_create" "/home/priikone/silc1/doc/toolkit/silcthread.html" 4 + "silc_thread_exit" "/home/priikone/silc1/doc/toolkit/silcthread.html" 4 + "silc_thread_self" "/home/priikone/silc1/doc/toolkit/silcthread.html" 4 + "silc_thread_wait" "/home/priikone/silc1/doc/toolkit/silcthread.html" 4 + "silc_thread_yield" "/home/priikone/silc1/doc/toolkit/silcthread.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silctime-SilcTime.html b/docs/toolkit/manual/silctime-SilcTime.html new file mode 100644 index 0000000..64a45cc --- /dev/null +++ b/docs/toolkit/manual/silctime-SilcTime.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcTime

    + + +NAME + +
    
+    typedef struct { ... } *SilcTime, SilcTimeStruct;
+
+
    +DESCRIPTION + +
    
+    This context represents time value.  It includes date and time
+    down to millisecond precision.  The structure size is 64 bits.
+
+
    +SOURCE + +
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_compare_timeval.html b/docs/toolkit/manual/silctime-silc_compare_timeval.html new file mode 100644 index 0000000..8eabb71 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_compare_timeval.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_compare_timeval

    + + +SYNOPSIS + +
    
+    int silc_compare_timeval(struct time_val *t1, struct time_val *t2);
+
+
    +DESCRIPTION + +
    
+    Compares `t1' and `t2' time structures and returns less than zero,
+    zero or more than zero when `t1' is smaller, equal or bigger than
+    `t2', respectively.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_gettimeofday.html b/docs/toolkit/manual/silctime-silc_gettimeofday.html new file mode 100644 index 0000000..5c3cc85 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_gettimeofday.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_gettimeofday

    + + +SYNOPSIS + +
    
+    int silc_gettimeofday(struct timeval *p);
+
+
    +DESCRIPTION + +
    
+    Return current time to struct timeval.  This function is system
+    dependant.  Returns 0 on success and -1 on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time.html b/docs/toolkit/manual/silctime-silc_time.html new file mode 100644 index 0000000..1785683 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time

    + + +SYNOPSIS + +
    
+    SilcInt64 silc_time(void);
+
+
    +DESCRIPTION + +
    
+    Returns the current time of the system since Epoch.  The returned
+    value is seconds since Epoch (1.1.1970).  Returns -1 on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_generalized.html b/docs/toolkit/manual/silctime-silc_time_generalized.html new file mode 100644 index 0000000..ccc0db1 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_generalized.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_generalized

    + + +SYNOPSIS + +
    
+    SilcBool silc_time_generalized(const char *generalized_time,
+                                   SilcTime ret_time);
+
+
    +DESCRIPTION + +
    
+    Returns time and date as SilcTime from `generalized_time' string which
+    format is "YYYYMMDDhhmmss.ppZ", where YYYY is year, MM is month, DD
+    is day, hh is hour, mm is minutes, ss is seconds which may have optional
+    precision pp, and Z is timezone, which by default is Zulu (UTC).
+    Generalized time is defined in ISO/EIC 8824-1.
+
+    Returns FALSE on error, TRUE otherwise.
+
+
    +EXAMPLE + +
    
+    SilcTimeStruct ret_time;
+
+    time is 2003/02/19 19:04:03 Zulu (UTC)
+    silc_time_generalized("20030219190403Z", &ret_time);
+
+    time is 2003/02/19 19:05:10.212 Zulu (UTC)
+    silc_time_generalized("20030219190510.212Z", &ret_time);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_generalized_string.html b/docs/toolkit/manual/silctime-silc_time_generalized_string.html new file mode 100644 index 0000000..513e04a --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_generalized_string.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_generalized_string

    + + +SYNOPSIS + +
    
+    SilcBool silc_time_generalized_string(SilcTime time_val,
+                                          char *ret_string,
+                                          SilcUInt32 ret_string_size);
+
+
    +DESCRIPTION + +
    
+    Encodes the SilcTime `time' into the generalized time format into the
+    `ret_string' buffer.  Returns FALSE if the buffer is too small.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_msec.html b/docs/toolkit/manual/silctime-silc_time_msec.html new file mode 100644 index 0000000..23bed47 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_msec.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_msec

    + + +SYNOPSIS + +
    
+    SilcInt64 silc_time_msec(void);
+
+
    +DESCRIPTION + +
    
+    Returns the current time of the system since Epoch in millisecond
+    resolution.  Returns - 1 on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_string.html b/docs/toolkit/manual/silctime-silc_time_string.html new file mode 100644 index 0000000..6e9b78c --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_string.html @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_string

    + + +SYNOPSIS + +
    
+    const char *silc_time_string(SilcInt64 time_val_sec);
+
+
    +DESCRIPTION + +
    
+    Returns time and date as string.  The caller must not free the string
+    and next call to this function will delete the old string.  If the
+    `time_val_sec' is zero (0) returns current time as string, otherwise the
+    `time_val_sec' as string.  The `time_val_sec' is in seconds since Epoch.
+    Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_universal.html b/docs/toolkit/manual/silctime-silc_time_universal.html new file mode 100644 index 0000000..98e89a8 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_universal.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_universal

    + + +SYNOPSIS + +
    
+    SilcBool silc_time_universal(const char *universal_time,
+                                 SilcTime ret_time);
+
+
    +DESCRIPTION + +
    
+    Returns time and date as SilcTime from `universal_time' string which
+    format is "YYMMDDhhmmssZ", where YY is year, MM is month, DD is day,
+    hh is hour, mm is minutes, ss is seconds and Z is timezone, which
+    by default is Zulu (UTC).  Universal time is defined in ISO/EIC 8824-1.
+
+    Returns FALSE on error, TRUE otherwise.
+
+
    +EXAMPLE + +
    
+    SilcTimeStruct ret_time;
+
+    time is 03/02/19 19:04:03 Zulu (UTC)
+    silc_time_universal("030219190403Z", &ret_time);
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_universal_string.html b/docs/toolkit/manual/silctime-silc_time_universal_string.html new file mode 100644 index 0000000..371a024 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_universal_string.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_universal_string

    + + +SYNOPSIS + +
    
+    SilcBool silc_time_universal_string(SilcTime time_val, char *ret_string,
+                                        SilcUInt32 ret_string_size);
+
+
    +DESCRIPTION + +
    
+    Encodes the SilcTime `time' into the universal time format into the
+    `ret_string' buffer.  Returns FALSE if the buffer is too small.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_usec.html b/docs/toolkit/manual/silctime-silc_time_usec.html new file mode 100644 index 0000000..0860dbb --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_usec.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_usec

    + + +SYNOPSIS + +
    
+    SilcInt64 silc_time_usec(void);
+
+
    +DESCRIPTION + +
    
+    Returns the current time of the system since Epoch in microsecond
+    resolution.  Returns - 1 on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_time_value.html b/docs/toolkit/manual/silctime-silc_time_value.html new file mode 100644 index 0000000..19f3863 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_time_value.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_time_value

    + + +SYNOPSIS + +
    
+   SilcBool silc_time_value(SilcInt64 time_val_msec, SilcTime ret_time);
+
+
    +DESCRIPTION + +
    
+    Returns time and date as SilcTime.  If the `time_val_msec' is zero (0)
+    returns current time as SilcTime, otherwise the `time_val_msec' as
+    SilcTime.  The `time_val_msec' is in milliseconds since Epoch.  Returns
+    FALSE on error, TRUE otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_timezone.html b/docs/toolkit/manual/silctime-silc_timezone.html new file mode 100644 index 0000000..0302d8f --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_timezone.html @@ -0,0 +1,231 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_timezone

    + + +SYNOPSIS + +
    
+    SilcBool silc_timezone(char *timezone, SilcUInt32 timezone_size);
+
+
    +DESCRIPTION + +
    
+    Returns current timezone in Universal time format into the `timezone'
+    buffer of size of `timezone_size'.  The possible values this function
+    returns are: Z (For UTC timezone), +hh (UTC + hours) -hh (UTC - hours),
+    +hh:mm (UTC + hours:minutes) or -hh:mm (UTC - hours:minutes).  The
+    returned values are always offsets to UTC.
+
+    Returns FALSE on error, TRUE otherwise.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime-silc_usleep.html b/docs/toolkit/manual/silctime-silc_usleep.html new file mode 100644 index 0000000..7bc6bd4 --- /dev/null +++ b/docs/toolkit/manual/silctime-silc_usleep.html @@ -0,0 +1,233 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_usleep

    + + +SYNOPSIS + +
    
+    void silc_usleep(long microseconds);
+
+
    +DESCRIPTION + +
    
+    Delays the execution of process/thread for the specified amount of
+    time, which is in microseconds.
+
+
    +NOTES + +
    
+    The delay is only approximate and on some platforms the resolution is
+    in fact milliseconds.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Time Interface
    +SilcTime
    +silc_time
    +silc_time_msec
    +silc_time_usec
    +silc_time_string
    +silc_time_value
    +silc_timezone
    +silc_time_universal
    +silc_time_universal_string
    +silc_time_generalized
    +silc_time_generalized_string
    +silc_compare_timeval
    +silc_gettimeofday
    +silc_usleep
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime.html b/docs/toolkit/manual/silctime.html new file mode 100644 index 0000000..9f409c8 --- /dev/null +++ b/docs/toolkit/manual/silctime.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silctime.html + + + + +
    + +SILC Time Interface
    Header: silctime.h

    + + +DESCRIPTION + +
    
+ This interface provides various utility functions for getting current
+ time and converting different time representations into the SilcTime
+ representation.
+
+
  • SilcTime +
  • silc_time +
  • silc_time_msec +
  • silc_time_usec +
  • silc_time_string +
  • silc_time_value +
  • silc_timezone +
  • silc_time_universal +
  • silc_time_universal_string +
  • silc_time_generalized +
  • silc_time_generalized_string +
  • silc_compare_timeval +
  • silc_gettimeofday +
  • silc_usleep + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctime.xref b/docs/toolkit/manual/silctime.xref new file mode 100644 index 0000000..428e66e --- /dev/null +++ b/docs/toolkit/manual/silctime.xref @@ -0,0 +1,21 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silctime.h" "/home/priikone/silc1/doc/toolkit/silctime.html" 0 + "SILC Time Interface" "/home/priikone/silc1/doc/toolkit/silctime.html" 1 + "SilcTime" "/home/priikone/silc1/doc/toolkit/silctime.html" 5 + "silc_time" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_msec" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_usec" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_string" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_value" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_timezone" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_universal" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_universal_string" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_generalized" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_time_generalized_string" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_compare_timeval" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_gettimeofday" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + "silc_usleep" "/home/priikone/silc1/doc/toolkit/silctime.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silctypes-FALSE.html b/docs/toolkit/manual/silctypes-FALSE.html new file mode 100644 index 0000000..53b8642 --- /dev/null +++ b/docs/toolkit/manual/silctypes-FALSE.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +FALSE

    + + +NAME + +
    
+    #define FALSE ...
+
+
    +DESCRIPTION + +
    
+    Boolean false value indicator.
+
+
    +SOURCE + +
        #ifndef FALSE
+    #define FALSE 0
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_32_TO_PTR.html b/docs/toolkit/manual/silctypes-SILC_32_TO_PTR.html new file mode 100644 index 0000000..1c484db --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_32_TO_PTR.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_32_TO_PTR

    + + +NAME + +
    
+    #define SILC_32_TO_PTR ...
+
+
    +DESCRIPTION + +
    
+    Type casts a 32-bit integer value into a pointer.  Use this to
+    avoid compiler warnings when type casting integers to pointers of
+    different size.
+
+
    +SOURCE + +
        #if SILC_SIZEOF_VOID_P < 8
+    #define SILC_32_TO_PTR(_ival__) ((void *)((SilcUInt32)(_ival__)))
+    #else
+    #define SILC_32_TO_PTR(_ival__) ((void *)((SilcUInt64)(_ival__)))
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_64_TO_PTR.html b/docs/toolkit/manual/silctypes-SILC_64_TO_PTR.html new file mode 100644 index 0000000..d0eec4c --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_64_TO_PTR.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_64_TO_PTR

    + + +NAME + +
    
+    #define SILC_64_TO_PTR ...
+
+
    +DESCRIPTION + +
    
+    Type casts a 64-bit integer value into a pointer.  Use this to
+    avoid compiler warnings when type casting integers to pointers of
+    different size.
+
+
    +SOURCE + +
        #if SILC_SIZEOF_VOID_P < 8
+    #define SILC_64_TO_PTR(_ival__)                                         \
+      ((void *)((SilcUInt32)((SilcUInt64)(_ival__) & (SilcUInt32)0xFFFFFFFFUL)))
+    #else
+    #define SILC_64_TO_PTR(_ival__) ((void *)((SilcUInt64)(_ival__)))
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_GET16_LSB.html b/docs/toolkit/manual/silctypes-SILC_GET16_LSB.html new file mode 100644 index 0000000..20b7ffa --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_GET16_LSB.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_GET16_LSB

    + + +NAME + +
    
+    #define SILC_GET16_MSB ...
+
+
    +DESCRIPTION + +
    
+    Return two 8-bit bytes, least significant bytes first.
+
+
    +SOURCE + +
        #if defined(SILC_I486) && defined(__GNUC__)
+    #define SILC_GET16_LSB(l, cp) (l) = (*(SilcUInt16 *)(cp))
+    #else
+    #define SILC_GET16_LSB(l, cp)                           \
+    do {                                                    \
+      (l) = ((SilcUInt32)(SilcUInt8)(cp)[0])                \
+        | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8);            \
+    } while(0)
+    #endif /* SILC_I486 && __GNUC__ */
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_GET16_MSB.html b/docs/toolkit/manual/silctypes-SILC_GET16_MSB.html new file mode 100644 index 0000000..906e177 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_GET16_MSB.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_GET16_MSB

    + + +NAME + +
    
+    #define SILC_GET16_MSB ...
+
+
    +DESCRIPTION + +
    
+    Return two 8-bit bytes, most significant bytes first.
+
+
    +SOURCE + +
        #define SILC_GET16_MSB(l, cp)                           \
+    do {                                                    \
+      (l) = ((SilcUInt32)(SilcUInt8)(cp)[0] << 8)           \
+        | ((SilcUInt32)(SilcUInt8)(cp)[1]);                 \
+    } while(0)
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_GET32_LSB.html b/docs/toolkit/manual/silctypes-SILC_GET32_LSB.html new file mode 100644 index 0000000..c5be28c --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_GET32_LSB.html @@ -0,0 +1,263 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_GET32_LSB

    + + +NAME + +
    
+    #define SILC_GET32_LSB ...
+
+
    +DESCRIPTION + +
    
+    Return four 8-bit bytes, least significant bytes first.
+
+
    +SOURCE + +
        #if defined(SILC_I486) && defined(__GNUC__)
+    #define SILC_GET32_LSB(l, cp) (l) = (*(SilcUInt32 *)(cp))
+    #else
+    #define SILC_GET32_LSB(l, cp)                           \
+    do {                                                    \
+      (l) = ((SilcUInt32)(SilcUInt8)(cp)[0])                \
+        | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)             \
+        | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16)            \
+        | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24);           \
+    } while(0)
+    #endif /* SILC_I486 && __GNUC__ */
+    
+    /* Same as upper but XOR the result always. Special purpose macro. */
+    #if defined(SILC_I486) && defined(__GNUC__)
+    #define SILC_GET32_X_LSB(l, cp) (l) ^= (*(SilcUInt32 *)(cp))
+    #else
+    #define SILC_GET32_X_LSB(l, cp)                         \
+      (l) ^= ((SilcUInt32)(SilcUInt8)(cp)[0])               \
+        | ((SilcUInt32)(SilcUInt8)(cp)[1] << 8)             \
+        | ((SilcUInt32)(SilcUInt8)(cp)[2] << 16)            \
+        | ((SilcUInt32)(SilcUInt8)(cp)[3] << 24)
+    #endif /* SILC_I486 && __GNUC__ */
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_GET32_MSB.html b/docs/toolkit/manual/silctypes-SILC_GET32_MSB.html new file mode 100644 index 0000000..2900d33 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_GET32_MSB.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_GET32_MSB

    + + +NAME + +
    
+    #define SILC_GET32_MSB ...
+
+
    +DESCRIPTION + +
    
+    Return four 8-bit bytes, most significant bytes first.
+
+
    +SOURCE + +
        #define SILC_GET32_MSB(l, cp)                           \
+    do {                                                    \
+      (l) = ((SilcUInt32)(SilcUInt8)(cp)[0]) << 24          \
+        | ((SilcUInt32)(SilcUInt8)(cp)[1] << 16)            \
+        | ((SilcUInt32)(SilcUInt8)(cp)[2] << 8)             \
+        | ((SilcUInt32)(SilcUInt8)(cp)[3]);                 \
+    } while(0)
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_GET64_MSB.html b/docs/toolkit/manual/silctypes-SILC_GET64_MSB.html new file mode 100644 index 0000000..633af3e --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_GET64_MSB.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_GET64_MSB

    + + +NAME + +
    
+    #define SILC_GET64_MSB ...
+
+
    +DESCRIPTION + +
    
+    Return eight 8-bit bytes, most significant bytes first.
+
+
    +SOURCE + +
        #define SILC_GET64_MSB(l, cp)                                   \
+    do {                                                            \
+      (l) = ((((SilcUInt64)SILC_GET_WORD((cp))) << 32) |            \
+             ((SilcUInt64)SILC_GET_WORD((cp) + 4)));                \
+    } while(0)
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_PTR_TO_32.html b/docs/toolkit/manual/silctypes-SILC_PTR_TO_32.html new file mode 100644 index 0000000..8d873ba --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_PTR_TO_32.html @@ -0,0 +1,249 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_PTR_TO_32

    + + +NAME + +
    
+    #define SILC_PTR_TO_32 ...
+
+
    +DESCRIPTION + +
    
+    Type casts a pointer's value into a 32-bit integer.  Use this to
+    avoid compiler warnings when type casting pointers to integers
+    of different size.
+
+
    +SOURCE + +
        #if SILC_SIZEOF_VOID_P < 8
+    #define SILC_PTR_TO_32(_ptr__) ((SilcUInt32)(_ptr__))
+    #else
+    #define SILC_PTR_TO_32(_ptr__)                                          \
+      ((SilcUInt32)((SilcUInt64)(_ptr__) & (SilcUInt32)0xFFFFFFFFUL))
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_PTR_TO_64.html b/docs/toolkit/manual/silctypes-SILC_PTR_TO_64.html new file mode 100644 index 0000000..2ff10e5 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_PTR_TO_64.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_PTR_TO_64

    + + +NAME + +
    
+    #define SILC_PTR_TO_64 ...
+
+
    +DESCRIPTION + +
    
+    Type casts a pointer's value into a 64-bit integer.  Use this to
+    avoid compiler warnings when type casting pointers to integers
+    of different size.
+
+
    +SOURCE + +
        #if SILC_SIZEOF_VOID_P < 8
+    #define SILC_PTR_TO_64(_ptr__) ((SilcUInt64)((SilcUInt32)(_ptr__)))
+    #else
+    #define SILC_PTR_TO_64(_ptr__) ((SilcUInt64)((SilcUInt64)(_ptr__)))
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_PUT16_LSB.html b/docs/toolkit/manual/silctypes-SILC_PUT16_LSB.html new file mode 100644 index 0000000..7ee231e --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_PUT16_LSB.html @@ -0,0 +1,250 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_PUT16_LSB

    + + +NAME + +
    
+    #define SILC_PUT16_LSB ...
+
+
    +DESCRIPTION + +
    
+    Put two 8-bit bytes, least significant bytes first.
+
+
    +SOURCE + +
        #if defined(SILC_I486) && defined(__GNUC__)
+    #define SILC_PUT16_LSB(l, cp) (*(SilcUInt16 *)(cp)) = (l)
+    #else
+    #define SILC_PUT16_LSB(l, cp)                   \
+    do  {                                           \
+      (cp)[0] = (SilcUInt8)(l);                     \
+      (cp)[1] = (SilcUInt8)((l) >> 8);              \
+    } while(0)
+    #endif /* SILC_I486 && __GNUC__ */
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_PUT16_MSB.html b/docs/toolkit/manual/silctypes-SILC_PUT16_MSB.html new file mode 100644 index 0000000..3016e17 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_PUT16_MSB.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_PUT16_MSB

    + + +NAME + +
    
+    #define SILC_PUT16_MSB ...
+
+
    +DESCRIPTION + +
    
+    Put two 8-bit bytes, most significant bytes first.
+
+
    +SOURCE + +
        #define SILC_PUT16_MSB(l, cp)                   \
+    do {                                            \
+      (cp)[0] = (SilcUInt8)((l) >> 8);              \
+      (cp)[1] = (SilcUInt8)(l);                     \
+    } while(0)
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_PUT32_LSB.html b/docs/toolkit/manual/silctypes-SILC_PUT32_LSB.html new file mode 100644 index 0000000..2e066b4 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_PUT32_LSB.html @@ -0,0 +1,252 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_PUT32_LSB

    + + +NAME + +
    
+    #define SILC_PUT32_LSB ...
+
+
    +DESCRIPTION + +
    
+    Put four 8-bit bytes, least significant bytes first.
+
+
    +SOURCE + +
        #if defined(SILC_I486) && defined(__GNUC__)
+    #define SILC_PUT32_LSB(l, cp) (*(SilcUInt32 *)(cp)) = (l)
+    #else
+    #define SILC_PUT32_LSB(l, cp)                   \
+    do {                                            \
+      (cp)[0] = (SilcUInt8)(l);                     \
+      (cp)[1] = (SilcUInt8)((l) >> 8);              \
+      (cp)[2] = (SilcUInt8)((l) >> 16);             \
+      (cp)[3] = (SilcUInt8)((l) >> 24);             \
+    } while(0)
+    #endif /* SILC_I486 && __GNUC__ */
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_PUT32_MSB.html b/docs/toolkit/manual/silctypes-SILC_PUT32_MSB.html new file mode 100644 index 0000000..eaf4645 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_PUT32_MSB.html @@ -0,0 +1,248 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_PUT32_MSB

    + + +NAME + +
    
+    #define SILC_PUT32_MSB ...
+
+
    +DESCRIPTION + +
    
+    Put four 8-bit bytes, most significant bytes first.
+
+
    +SOURCE + +
        #define SILC_PUT32_MSB(l, cp)                   \
+    do {                                            \
+      (cp)[0] = (SilcUInt8)((l) >> 24);             \
+      (cp)[1] = (SilcUInt8)((l) >> 16);             \
+      (cp)[2] = (SilcUInt8)((l) >> 8);              \
+      (cp)[3] = (SilcUInt8)(l);                     \
+    } while(0)
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_PUT64_MSB.html b/docs/toolkit/manual/silctypes-SILC_PUT64_MSB.html new file mode 100644 index 0000000..d27c781 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_PUT64_MSB.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_PUT64_MSB

    + + +NAME + +
    
+    #define SILC_PUT64_MSB ...
+
+
    +DESCRIPTION + +
    
+    Put eight 8-bit bytes, most significant bytes first.
+
+
    +SOURCE + +
        #define SILC_PUT64_MSB(l, cp)                                   \
+    do {                                                            \
+      SILC_PUT32_MSB((SilcUInt32)((SilcUInt64)(l) >> 32), (cp));    \
+      SILC_PUT32_MSB((SilcUInt32)(l), (cp) + 4);                    \
+    } while(0)
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_SWAB_16.html b/docs/toolkit/manual/silctypes-SILC_SWAB_16.html new file mode 100644 index 0000000..790279c --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_SWAB_16.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_SWAB_16

    + + +NAME + +
    
+    #define SILC_SWAB_16 ...
+
+
    +DESCRIPTION + +
    
+    Swabs 16-bit unsigned integer byte order.
+
+
    +SOURCE + +
        #define SILC_SWAB_16(l)                                         \
+      ((SilcUInt16)(((SilcUInt16)(l) & (SilcUInt16)0x00FFU) << 8) | \
+                   (((SilcUInt16)(l) & (SilcUInt16)0xFF00U) >> 8))
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SILC_SWAB_32.html b/docs/toolkit/manual/silctypes-SILC_SWAB_32.html new file mode 100644 index 0000000..f19c013 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SILC_SWAB_32.html @@ -0,0 +1,246 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SILC_SWAB_32

    + + +NAME + +
    
+    #define SILC_SWAB_32 ...
+
+
    +DESCRIPTION + +
    
+    Swabs 32-bit unsigned integer byte order.
+
+
    +SOURCE + +
        #define SILC_SWAB_32(l)                                                 \
+      ((SilcUInt32)(((SilcUInt32)(l) & (SilcUInt32)0x000000FFUL) << 24) |   \
+                   (((SilcUInt32)(l) & (SilcUInt32)0x0000FF00UL) << 8)  |   \
+                   (((SilcUInt32)(l) & (SilcUInt32)0x00FF0000UL) >> 8)  |   \
+                   (((SilcUInt32)(l) & (SilcUInt32)0xFF000000UL) >> 24))
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcBool.html b/docs/toolkit/manual/silctypes-SilcBool.html new file mode 100644 index 0000000..88a5e1e --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcBool.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcBool

    + + +NAME + +
    
+    typedef unigned char SilcBool;
+
+
    +DESCRIPTION + +
    
+    Boolean value, and is always 8-bits.  Represents value 0 or 1.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcInt16.html b/docs/toolkit/manual/silctypes-SilcInt16.html new file mode 100644 index 0000000..7e8acb7 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcInt16.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcInt16

    + + +NAME + +
    
+    typedef signed short SilcInt16;
+
+
    +DESCRIPTION + +
    
+    16-bit signed integer.  Guaranteed to be 16-bits.
+
+
    +SOURCE + +
        typedef signed short SilcInt16;
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcInt32.html b/docs/toolkit/manual/silctypes-SilcInt32.html new file mode 100644 index 0000000..ab81cda --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcInt32.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcInt32

    + + +NAME + +
    
+    typedef signed long SilcInt32;
+
+
    +DESCRIPTION + +
    
+    32-bit signed integer.  Guaranteed to be 32-bits.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcInt64.html b/docs/toolkit/manual/silctypes-SilcInt64.html new file mode 100644 index 0000000..80b8e8f --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcInt64.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcInt64

    + + +NAME + +
    
+    typedef signed long long SilcInt64;
+
+
    +DESCRIPTION + +
    
+    64-bit signed integer.  Guaranteed to be 64-bits on systems that
+    support it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcInt8.html b/docs/toolkit/manual/silctypes-SilcInt8.html new file mode 100644 index 0000000..321613e --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcInt8.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcInt8

    + + +NAME + +
    
+    typedef signed char SilcInt8;
+
+
    +DESCRIPTION + +
    
+    8-bit signed integer.
+
+
    +SOURCE + +
        typedef signed char SilcInt8;
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcSocket.html b/docs/toolkit/manual/silctypes-SilcSocket.html new file mode 100644 index 0000000..1592cef --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcSocket.html @@ -0,0 +1,251 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcSocket

    + + +NAME + +
    
+    SilcSocket
+
+
    +DESCRIPTION + +
    
+    Platform specific socket.  On POSIX compliant systems this is simply
+    an integer, representing the socket. On other systems it is platform
+    specific socket context.  Access it only through routines that can
+    handle SilcSocket types, unless you know what you are doing.
+
+
    +SOURCE + +
        #if defined(SILC_UNIX)
+    typedef int SilcSocket;
+    #elif defined(SILC_WIN32)
+    typedef SOCKET SilcSocket;
+    #elif defined(SILC_SYMBIAN)
+    typedef void * SilcSocket;
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcUInt16.html b/docs/toolkit/manual/silctypes-SilcUInt16.html new file mode 100644 index 0000000..1162c02 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcUInt16.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcUInt16

    + + +NAME + +
    
+    typedef unsigned short SilcUInt16;
+
+
    +DESCRIPTION + +
    
+    16-bit unsigned integer.  Guaranteed to be 16-bits.
+
+
    +SOURCE + +
        typedef unsigned short SilcUInt16;
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcUInt32.html b/docs/toolkit/manual/silctypes-SilcUInt32.html new file mode 100644 index 0000000..3a5740d --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcUInt32.html @@ -0,0 +1,257 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcUInt32

    + + +NAME + +
    
+    typedef unsigned long SilcUInt32;
+
+
    +DESCRIPTION + +
    
+    32-bit unsigned integer.  Guaranteed to be 32-bits.
+
+
    +SOURCE + +
        #if SILC_SIZEOF_INT == 4
+    typedef unsigned int SilcUInt32;
+    typedef signed int SilcInt32;
+    #else
+    #if SILC_SIZEOF_LONG == 4
+    typedef unsigned long SilcUInt32;
+    typedef signed long SilcInt32;
+    #else
+    #if SILC_SIZEOF_LONG_LONG >= 4
+    #ifndef WIN32
+    typedef unsigned long long SilcUInt32;
+    typedef signed long long SilcInt32;
+    #endif
+    #endif
+    #endif
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcUInt64.html b/docs/toolkit/manual/silctypes-SilcUInt64.html new file mode 100644 index 0000000..2c3e0c9 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcUInt64.html @@ -0,0 +1,259 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcUInt64

    + + +NAME + +
    
+    typedef unsigned long long SilcUInt64;
+
+
    +DESCRIPTION + +
    
+    64-bit unsigned integer.  Guaranteed to be 64-bits on systems that
+    support it.
+
+
    +SOURCE + +
        #if SILC_SIZEOF_LONG >= 8
+    typedef unsigned long SilcUInt64;
+    typedef signed long SilcInt64;
+    #else
+    #if SILC_SIZEOF_LONG_LONG >= 8
+    #ifndef WIN32
+    typedef unsigned long long SilcUInt64;
+    typedef signed long long SilcInt64;
+    #else
+    typedef unsigned __int64 SilcUInt64;
+    typedef signed __int64 SilcInt64;
+    #endif
+    #else
+    typedef SilcUInt32 SilcUInt64;
+    typedef SilcInt32 SilcInt64;
+    #endif
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-SilcUInt8.html b/docs/toolkit/manual/silctypes-SilcUInt8.html new file mode 100644 index 0000000..3aa8b64 --- /dev/null +++ b/docs/toolkit/manual/silctypes-SilcUInt8.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +SilcUInt8

    + + +NAME + +
    
+    typedef unsigned char SilcUInt8;
+
+
    +DESCRIPTION + +
    
+    8-bit unsigned integer.
+
+
    +SOURCE + +
        typedef unsigned char SilcUInt8;
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes-TRUE.html b/docs/toolkit/manual/silctypes-TRUE.html new file mode 100644 index 0000000..31d5147 --- /dev/null +++ b/docs/toolkit/manual/silctypes-TRUE.html @@ -0,0 +1,244 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +TRUE

    + + +NAME + +
    
+    #define TRUE ...
+
+
    +DESCRIPTION + +
    
+    Boolean true value indicator.
+
+
    +SOURCE + +
        #ifndef TRUE
+    #define TRUE 1
+    #endif
    +



    +
    +     		+ + + + +
    +
    + +SILC Types
    +SilcBool
    +TRUE
    +FALSE
    +SilcUInt8
    +SilcInt8
    +SilcUInt16
    +SilcInt16
    +SilcUInt32
    +SilcInt32
    +SilcUInt64
    +SilcInt64
    +SilcSocket
    +SILC_GET16_MSB
    +SILC_GET32_MSB
    +SILC_GET64_MSB
    +SILC_GET16_LSB
    +SILC_GET32_LSB
    +SILC_PUT16_MSB
    +SILC_PUT32_MSB
    +SILC_PUT64_MSB
    +SILC_PUT16_LSB
    +SILC_PUT32_LSB
    +SILC_SWAB_16
    +SILC_SWAB_32
    +SILC_PTR_TO_32
    +SILC_PTR_TO_64
    +SILC_32_TO_PTR
    +SILC_64_TO_PTR
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes.html b/docs/toolkit/manual/silctypes.html new file mode 100644 index 0000000..06a3cff --- /dev/null +++ b/docs/toolkit/manual/silctypes.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silctypes.html + + + + +
    + +SILC Types
    Header: silctypes.h

    + + +DESCRIPTION + +
    
+    This header includes the most basic types used in the SILC source
+    tree, such as arithmetic types and their manipulation macros.  This
+    file is included in the silcincludes.h and is automatically available
+    for application.
+
+
  • SilcBool +
  • TRUE +
  • FALSE +
  • SilcUInt8 +
  • SilcInt8 +
  • SilcUInt16 +
  • SilcInt16 +
  • SilcUInt32 +
  • SilcInt32 +
  • SilcUInt64 +
  • SilcInt64 +
  • SilcSocket +
  • SILC_GET16_MSB +
  • SILC_GET32_MSB +
  • SILC_GET64_MSB +
  • SILC_GET16_LSB +
  • SILC_GET32_LSB +
  • SILC_PUT16_MSB +
  • SILC_PUT32_MSB +
  • SILC_PUT64_MSB +
  • SILC_PUT16_LSB +
  • SILC_PUT32_LSB +
  • SILC_SWAB_16 +
  • SILC_SWAB_32 +
  • SILC_PTR_TO_32 +
  • SILC_PTR_TO_64 +
  • SILC_32_TO_PTR +
  • SILC_64_TO_PTR + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silctypes.xref b/docs/toolkit/manual/silctypes.xref new file mode 100644 index 0000000..ee47f9f --- /dev/null +++ b/docs/toolkit/manual/silctypes.xref @@ -0,0 +1,35 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silctypes.h" "/home/priikone/silc1/doc/toolkit/silctypes.html" 0 + "SILC Types" "/home/priikone/silc1/doc/toolkit/silctypes.html" 1 + "SilcBool" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "TRUE" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "FALSE" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcUInt8" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcInt8" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcUInt16" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcInt16" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcUInt32" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcInt32" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcUInt64" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcInt64" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SilcSocket" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_GET16_MSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_GET32_MSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_GET64_MSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_GET16_LSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_GET32_LSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_PUT16_MSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_PUT32_MSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_PUT64_MSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_PUT16_LSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_PUT32_LSB" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_SWAB_16" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_SWAB_32" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_PTR_TO_32" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_PTR_TO_64" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_32_TO_PTR" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + "SILC_64_TO_PTR" "/home/priikone/silc1/doc/toolkit/silctypes.html" 8 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_c2w.html b/docs/toolkit/manual/silcutf8-silc_utf8_c2w.html new file mode 100644 index 0000000..4f2033c --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_c2w.html @@ -0,0 +1,230 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_c2w

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_utf8_c2w(const unsigned char *utf8,
+                             SilcUInt32 utf8_len,
+                             SilcUInt16 *utf8_wide,
+                             SilcUInt32 utf8_wide_size);
+
+
    +DESCRIPTION + +
    
+    Converts UTF-8 string into UTF-8 wide character string into the
+    `utf8_wide' buffer of size of `utf8_wide_size' in characters.  Returns
+    the length of the UTF-8 wide character string or 0 on error.  The
+    returned length is in characters and not in bytes.  The byte length
+    is twice the returned character length.
+
+    If there is extra space in `utf8_wide' this will NULL terminate the
+    string automatically.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_decode.html b/docs/toolkit/manual/silcutf8-silc_utf8_decode.html new file mode 100644 index 0000000..8882a8a --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_decode.html @@ -0,0 +1,228 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_decode

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_utf8_decode(const unsigned char *utf8,
+                                SilcUInt32 utf8_len,
+                                SilcStringEncoding bin_encoding,
+                                unsigned char *bin, SilcUInt32 bin_size);
+
+
    +DESCRIPTION + +
    
+    Decodes UTF-8 encoded string `utf8' to string of which encoding is
+    to be `bin_encoding', into the `bin' buffer of size of `bin_size'.
+    Returns the length of the decoded buffer, or zero (0) on error.
+    By default `bin_encoding' is ASCII, and the caller needs to know to
+    which encoding the output string is to be encoded if ASCII is not
+    desired.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_decoded_len.html b/docs/toolkit/manual/silcutf8-silc_utf8_decoded_len.html new file mode 100644 index 0000000..1672426 --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_decoded_len.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_decoded_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_utf8_decoded_len(const unsigned char *bin,
+                                     SilcUInt32 bin_len,
+                                     SilcStringEncoding bin_encoding);
+
+
    +DESCRIPTION + +
    
+    Returns the length of decoded string if the `bin' of encoding of
+    `bin_encoding' is decoded with silc_utf8_decode.  Returns zero (0)
+    on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_encode.html b/docs/toolkit/manual/silcutf8-silc_utf8_encode.html new file mode 100644 index 0000000..79c9945 --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_encode.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_encode

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_utf8_encode(const unsigned char *bin, SilcUInt32 bin_len,
+                                SilcStringEncoding bin_encoding,
+                                unsigned char *utf8, SilcUInt32 utf8_size);
+
+
    +DESCRIPTION + +
    
+    Encodes the string `bin' of which encoding is `bin_encoding' to the
+    UTF-8 encoding into the buffer `utf8' which is of size of `utf8_size'.
+    Returns the length of the UTF-8 encoded string, or zero (0) on error.
+    By default `bin_encoding' is ASCII, and the caller needs to know the
+    encoding of the input string if it is anything else.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_encoded_len.html b/docs/toolkit/manual/silcutf8-silc_utf8_encoded_len.html new file mode 100644 index 0000000..52bc8bb --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_encoded_len.html @@ -0,0 +1,224 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_encoded_len

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_utf8_encoded_len(const unsigned char *bin,
+                                     SilcUInt32 bin_len,
+                                     SilcStringEncoding bin_encoding);
+
+
    +DESCRIPTION + +
    
+    Returns the length of UTF-8 encoded string if the `bin' of
+    encoding of `bin_encoding' is encoded with silc_utf8_encode.
+    Returns zero (0) on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_strcasecmp.html b/docs/toolkit/manual/silcutf8-silc_utf8_strcasecmp.html new file mode 100644 index 0000000..b4e3626 --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_strcasecmp.html @@ -0,0 +1,226 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_strcasecmp

    + + +SYNOPSIS + +
    
+    SilcBool silc_utf8_strcasecmp(const char *s1, const char *s2);
+
+
    +DESCRIPTION + +
    
+    The silc_utf8_strcasecmp() function compares the two strings s1 and s2,
+    ignoring the case of the characters.  It returns TRUE if the strings
+    match and FALSE if they differ.
+
+    This functions expects NULL terminated UTF-8 strings.  The strings
+    will be casefolded and normalized before comparing.  Certain special
+    Unicode characters will be ignored when comparing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_strncasecmp.html b/docs/toolkit/manual/silcutf8-silc_utf8_strncasecmp.html new file mode 100644 index 0000000..8d9f571 --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_strncasecmp.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_strncasecmp

    + + +SYNOPSIS + +
    
+    SilcBool silc_utf8_strcasecmp(const char *s1, const char *s2,
+                                  SilcUInt32 n);
+
+
    +DESCRIPTION + +
    
+    The silc_utf8_strcasecmp() function compares the two strings s1 and s2,
+    ignoring the case of the characters.  It returns TRUE if the strings
+    match and FALSE if they differ.
+
+    This functions expects NULL terminated UTF-8 strings.  The strings
+    will be casefolded and normalized before comparing.  Certain special
+    Unicode characters will be ignored when comparing.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_valid.html b/docs/toolkit/manual/silcutf8-silc_utf8_valid.html new file mode 100644 index 0000000..542be59 --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_valid.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_valid

    + + +SYNOPSIS + +
    
+    SilcBool silc_utf8_valid(const unsigned char *utf8, SilcUInt32 utf8_len);
+
+
    +DESCRIPTION + +
    
+    Returns TRUE if the `utf8' string of length of `utf8_len' is valid
+    UTF-8 encoded string, FALSE if it is not UTF-8 encoded string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8-silc_utf8_w2c.html b/docs/toolkit/manual/silcutf8-silc_utf8_w2c.html new file mode 100644 index 0000000..65c10ad --- /dev/null +++ b/docs/toolkit/manual/silcutf8-silc_utf8_w2c.html @@ -0,0 +1,227 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_utf8_w2c

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_utf8_w2c(const SilcUInt16 *wide_str,
+                             SilcUInt32 wide_str_len,
+                             unsigned char *utf8, SilcUInt32 utf8_size);
+
+
    +DESCRIPTION + +
    
+    Converts UTF-8 wide character string into UTF-8 binary string into the
+    `utf8' buffer of size of `utf8_size' in bytes.  Returns the length of
+    the encoded UTF-8 string in bytes or 0 on error.
+
+    If there is extra space in `utf8' this will NULL terminate the string
+    automatically.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC UTF-8 Interface
    +silc_utf8_encode
    +silc_utf8_decode
    +silc_utf8_c2w
    +silc_utf8_w2c
    +silc_utf8_encoded_len
    +silc_utf8_decoded_len
    +silc_utf8_valid
    +silc_utf8_strcasecmp
    +silc_utf8_strncasecmp
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8.html b/docs/toolkit/manual/silcutf8.html new file mode 100644 index 0000000..4090b30 --- /dev/null +++ b/docs/toolkit/manual/silcutf8.html @@ -0,0 +1,223 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcutf8.html + + + + +
    + +SILC UTF-8 Interface
    Header: silcutf8.h

    + + +DESCRIPTION + +
    
+ Interface for the UTF-8 Unicode encoding form.  These routines provides
+ applications full UTF-8 and Unicode support.  It supports UTF-8 encoding
+ to and decoding from myriad of other character encodings.
+
+
  • silc_utf8_encode +
  • silc_utf8_decode +
  • silc_utf8_c2w +
  • silc_utf8_w2c +
  • silc_utf8_encoded_len +
  • silc_utf8_decoded_len +
  • silc_utf8_valid +
  • silc_utf8_strcasecmp +
  • silc_utf8_strncasecmp + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutf8.xref b/docs/toolkit/manual/silcutf8.xref new file mode 100644 index 0000000..daacbe3 --- /dev/null +++ b/docs/toolkit/manual/silcutf8.xref @@ -0,0 +1,16 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcutf8.h" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 0 + "SILC UTF-8 Interface" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 1 + "silc_utf8_encode" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_decode" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_c2w" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_w2c" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_encoded_len" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_decoded_len" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_valid" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_strcasecmp" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + "silc_utf8_strncasecmp" "/home/priikone/silc1/doc/toolkit/silcutf8.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcutil-silc_check_line.html b/docs/toolkit/manual/silcutil-silc_check_line.html new file mode 100644 index 0000000..0ea546d --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_check_line.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_check_line

    + + +SYNOPSIS + +
    
+    int silc_check_line(char *buf);
+
+
    +DESCRIPTION + +
    
+    Checks line for illegal characters. Return -1 when illegal character
+    were found. This is used to check for bad lines when reading data from
+    for example a configuration file.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_fingerprint.html b/docs/toolkit/manual/silcutil-silc_fingerprint.html new file mode 100644 index 0000000..286aba4 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_fingerprint.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_fingerprint

    + + +SYNOPSIS + +
    
+    char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Return a textual representation of the fingerprint in *data, the
+    caller must free the returned string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_format.html b/docs/toolkit/manual/silcutil-silc_format.html new file mode 100644 index 0000000..b6a54ee --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_format.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_format

    + + +SYNOPSIS + +
    
+    char *silc_format(char *fmt, ...);
+
+
    +DESCRIPTION + +
    
+    Formats arguments to a string and returns it after allocating memory
+    for it. It must be remembered to free it later.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_get_input.html b/docs/toolkit/manual/silcutil-silc_get_input.html new file mode 100644 index 0000000..d3c51ab --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_get_input.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_get_input

    + + +SYNOPSIS + +
    
+    char *silc_get_input(const char *prompt, SilcBool echo_off);
+
+
    +DESCRIPTION + +
    
+    Displays input prompt on command line and takes input data from user.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_get_real_name.html b/docs/toolkit/manual/silcutil-silc_get_real_name.html new file mode 100644 index 0000000..bb50f8c --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_get_real_name.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_get_real_name

    + + +SYNOPSIS + +
    
+    char *silc_get_real_name();
+
+
    +DESCRIPTION + +
    
+    Returns the real name of ther user from the passwd file.  The
+    caller must free the returned name.
+
+    This function is system dependant.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_get_username.html b/docs/toolkit/manual/silcutil-silc_get_username.html new file mode 100644 index 0000000..bd0ff1b --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_get_username.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_get_username

    + + +SYNOPSIS + +
    
+    char *silc_get_username();
+
+
    +DESCRIPTION + +
    
+    Returns the username of the user. If the global variable LOGNAME
+    does not exists we will get the name from the passwd file.  The
+    caller must free the returned name.
+
+    This function is system dependant.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_gets.html b/docs/toolkit/manual/silcutil-silc_gets.html new file mode 100644 index 0000000..04aeac6 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_gets.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_gets

    + + +SYNOPSIS + +
    
+    int silc_gets(char *dest, int destlen, const char *src, int srclen,
+                  int begin);
+
+
    +DESCRIPTION + +
    
+    Gets line from a buffer. Stops reading when a newline or EOF occurs.
+    This doesn't remove the newline sign from the destination buffer. The
+    argument begin is returned and should be passed again for the function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_client_id_compare.html b/docs/toolkit/manual/silcutil-silc_hash_client_id_compare.html new file mode 100644 index 0000000..227ef75 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_client_id_compare.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_client_id_compare

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_client_id_compare(void *key1, void *key2,
+                                         void *user_context);
+
+
    +DESCRIPTION + +
    
+    Compare two Client ID's entirely and not just the hash from the ID.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_client_id_hash.html b/docs/toolkit/manual/silcutil-silc_hash_client_id_hash.html new file mode 100644 index 0000000..d9fa556 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_client_id_hash.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_client_id_hash

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context)
+
+
    +DESCRIPTION + +
    
+    Hash Client ID's hash.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_data.html b/docs/toolkit/manual/silcutil-silc_hash_data.html new file mode 100644 index 0000000..2de8f67 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_data.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_data

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_data(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    Hash binary data. The `user_context' is the data length.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_data_compare.html b/docs/toolkit/manual/silcutil-silc_hash_data_compare.html new file mode 100644 index 0000000..e632da2 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_data_compare.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_data_compare

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_data_compare(void *key1, void *key2,
+                                    void *user_context);
+
+
    +DESCRIPTION + +
    
+    Compares binary data. May be used as SilcHashTable comparison function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_id.html b/docs/toolkit/manual/silcutil-silc_hash_id.html new file mode 100644 index 0000000..3b07bf6 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_id.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_id

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_id(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    Hash a ID. The `user_context' is the ID type.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_id_compare.html b/docs/toolkit/manual/silcutil-silc_hash_id_compare.html new file mode 100644 index 0000000..462521b --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_id_compare.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_id_compare

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_id_compare(void *key1, void *key2,
+                                  void *user_context);
+
+
    +DESCRIPTION + +
    
+    Compares two ID's. May be used as SilcHashTable comparison function.
+    The Client ID's compares only the hash of the Client ID not any other
+    part of the Client ID. Other ID's are fully compared.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_id_compare_full.html b/docs/toolkit/manual/silcutil-silc_hash_id_compare_full.html new file mode 100644 index 0000000..56985ec --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_id_compare_full.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_id_compare_full

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_id_compare_full(void *key1, void *key2,
+                                       void *user_context)
+
+
    +DESCRIPTION + +
    
+    Compares two ID's. May be used as SilcHashTable comparison function.
+    To compare full ID's instead of only partial, like the
+    silc_hash_id_compare does, use this function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_ptr.html b/docs/toolkit/manual/silcutil-silc_hash_ptr.html new file mode 100644 index 0000000..3c1aca9 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_ptr.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_ptr

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_ptr(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    Basic hash funtion to hash pointers. May be used with the SilcHashTable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_public_key.html b/docs/toolkit/manual/silcutil-silc_hash_public_key.html new file mode 100644 index 0000000..e83cd6f --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_public_key.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_public_key

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_public_key(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    Hash public key of any type.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_public_key_compare.html b/docs/toolkit/manual/silcutil-silc_hash_public_key_compare.html new file mode 100644 index 0000000..db9fe60 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_public_key_compare.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_public_key_compare

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_public_key_compare(void *key1, void *key2,
+                                          void *user_context);
+
+
    +DESCRIPTION + +
    
+    Compares two SILC Public keys. It may be used as SilcHashTable
+    comparison function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_string.html b/docs/toolkit/manual/silcutil-silc_hash_string.html new file mode 100644 index 0000000..44fb9cd --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_string.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_string

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_string(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    Basic has function to hash strings. May be used with the SilcHashTable.
+    Note that this lowers the characters of the string (with tolower()) so
+    this is used usually with nicknames, channel and server names to provide
+    case insensitive keys.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_string_compare.html b/docs/toolkit/manual/silcutil-silc_hash_string_compare.html new file mode 100644 index 0000000..e555ccf --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_string_compare.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_string_compare

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_string_compare(void *key1, void *key2,
+                                  void *user_context);
+
+
    +DESCRIPTION + +
    
+    Compares two strings. It may be used as SilcHashTable comparison
+    function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_uint.html b/docs/toolkit/manual/silcutil-silc_hash_uint.html new file mode 100644 index 0000000..204cc99 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_uint.html @@ -0,0 +1,239 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_uint

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_uint(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    Basic hash function to hash integers. May be used with the SilcHashTable.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_utf8_compare.html b/docs/toolkit/manual/silcutil-silc_hash_utf8_compare.html new file mode 100644 index 0000000..78488db --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_utf8_compare.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_utf8_compare

    + + +SYNOPSIS + +
    
+    SilcBool silc_hash_utf8_compare(void *key1, void *key2,
+                                    void *user_context);
+
+
    +DESCRIPTION + +
    
+    Compares UTF-8 strings.  Casefolded and NULL terminated strings are
+    expected.  May be used as SilcHashTable comparison function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_hash_utf8_string.html b/docs/toolkit/manual/silcutil-silc_hash_utf8_string.html new file mode 100644 index 0000000..4f8d89a --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_hash_utf8_string.html @@ -0,0 +1,241 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_hash_utf8_string

    + + +SYNOPSIS + +
    
+    SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
+
+
    +DESCRIPTION + +
    
+    Basic has function to hash UTF-8 strings. May be used with the
+    SilcHashTable.  Used with identifier strings.  The key is
+    expected to be casefolded.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_parse_command_line.html b/docs/toolkit/manual/silcutil-silc_parse_command_line.html new file mode 100644 index 0000000..9462b9c --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_parse_command_line.html @@ -0,0 +1,247 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_parse_command_line

    + + +SYNOPSIS + +
    
+    void silc_parse_command_line(unsigned char *buffer,
+                                 unsigned char ***parsed,
+                                 SilcUInt32 **parsed_lens,
+                                 SilcUInt32 **parsed_types,
+                                 SilcUInt32 *parsed_num,
+                                 SilcUInt32 max_args);
+
+
    +DESCRIPTION + +
    
+    Parses command line. At most `max_args' is taken. Rest of the line
+    will be allocated as the last argument if there are more than `max_args'
+    arguments in the line. Note that the command name is counted as one
+    argument and is saved.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_parse_userfqdn.html b/docs/toolkit/manual/silcutil-silc_parse_userfqdn.html new file mode 100644 index 0000000..b2dbe1f --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_parse_userfqdn.html @@ -0,0 +1,243 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_parse_userfqdn

    + + +SYNOPSIS + +
    
+    int silc_parse_userfqdn(const char *string,
+                            char *user, SilcUInt32 user_size,
+                            char *fqdn, SilcUInt32 fqdn_size);
+
+
    +DESCRIPTION + +
    
+    Parse userfqdn string which is in user@fqdn format.  Returns 0 on
+    error, 1 if `user' was filled and 2 if both `user' and `fqdn'
+    was filled.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_string_is_ascii.html b/docs/toolkit/manual/silcutil-silc_string_is_ascii.html new file mode 100644 index 0000000..87a57d4 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_string_is_ascii.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_string_is_ascii

    + + +SYNOPSIS + +
    
+    SilcBool silc_string_is_ascii(const unsigned char *data,
+                              SilcUInt32 data_len);
+
+
    +DESCRIPTION + +
    
+    Return TRUE if the `data' is ASCII string.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_to_lower.html b/docs/toolkit/manual/silcutil-silc_to_lower.html new file mode 100644 index 0000000..53f53f0 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_to_lower.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_to_lower

    + + +SYNOPSIS + +
    
+    SilcBool silc_to_lower(const char *string, char *dest,
+                           SilcUInt32 dest_size);
+
+
    +DESCRIPTION + +
    
+    Converts string to capital characters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_to_upper.html b/docs/toolkit/manual/silcutil-silc_to_upper.html new file mode 100644 index 0000000..fc3cc01 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_to_upper.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_to_upper

    + + +SYNOPSIS + +
    
+    SilcBool silc_to_upper(const char *string, char *dest,
+                           SilcUInt32 dest_size);
+
+
    +DESCRIPTION + +
    
+    Converts string to capital characters.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil-silc_va_copy.html b/docs/toolkit/manual/silcutil-silc_va_copy.html new file mode 100644 index 0000000..bafaaa6 --- /dev/null +++ b/docs/toolkit/manual/silcutil-silc_va_copy.html @@ -0,0 +1,242 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_va_copy

    + + +SYNOPSIS + +
    
+    void silc_va_copy(va_list dest, va_list src);
+
+
    +DESCRIPTION + +
    
+    Copies variable argument list.  This must be called in case the
+    variable argument list must be evaluated multiple times.  For each
+    evaluation the list must be copied and va_end must be called for
+    each copied list.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC Utilities
    +silc_gets
    +silc_check_line
    +silc_to_upper
    +silc_to_lower
    +silc_parse_userfqdn
    +silc_parse_command_line
    +silc_format
    +silc_hash_string
    +silc_hash_utf8_string
    +silc_hash_uint
    +silc_hash_ptr
    +silc_hash_id
    +silc_hash_client_id_hash
    +silc_hash_data
    +silc_hash_public_key
    +silc_hash_string_compare
    +silc_hash_id_compare
    +silc_hash_id_compare_full
    +silc_hash_client_id_compare
    +silc_hash_data_compare
    +silc_hash_utf8_compare
    +silc_hash_public_key_compare
    +silc_fingerprint
    +silc_string_is_ascii
    +silc_get_input
    +silc_get_username
    +silc_get_real_name
    +silc_va_copy
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil.html b/docs/toolkit/manual/silcutil.html new file mode 100644 index 0000000..5910a69 --- /dev/null +++ b/docs/toolkit/manual/silcutil.html @@ -0,0 +1,240 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcutil.html + + + + +
    + +SILC Utilities
    Header: silcutil.h

    + + +DESCRIPTION + +
    
+    Utility functions.
+
+
  • silc_gets +
  • silc_check_line +
  • silc_to_upper +
  • silc_to_lower +
  • silc_parse_userfqdn +
  • silc_parse_command_line +
  • silc_format +
  • silc_hash_string +
  • silc_hash_utf8_string +
  • silc_hash_uint +
  • silc_hash_ptr +
  • silc_hash_id +
  • silc_hash_client_id_hash +
  • silc_hash_data +
  • silc_hash_public_key +
  • silc_hash_string_compare +
  • silc_hash_id_compare +
  • silc_hash_id_compare_full +
  • silc_hash_client_id_compare +
  • silc_hash_data_compare +
  • silc_hash_utf8_compare +
  • silc_hash_public_key_compare +
  • silc_fingerprint +
  • silc_string_is_ascii +
  • silc_get_input +
  • silc_get_username +
  • silc_get_real_name +
  • silc_va_copy + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcutil.xref b/docs/toolkit/manual/silcutil.xref new file mode 100644 index 0000000..5e0b2c8 --- /dev/null +++ b/docs/toolkit/manual/silcutil.xref @@ -0,0 +1,35 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcutil.h" "/home/priikone/silc1/doc/toolkit/silcutil.html" 0 + "SILC Utilities" "/home/priikone/silc1/doc/toolkit/silcutil.html" 1 + "silc_gets" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_check_line" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_to_upper" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_to_lower" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_parse_userfqdn" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_parse_command_line" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_format" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_string" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_utf8_string" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_uint" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_ptr" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_id" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_client_id_hash" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_data" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_public_key" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_string_compare" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_id_compare" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_id_compare_full" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_client_id_compare" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_data_compare" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_utf8_compare" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_hash_public_key_compare" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_fingerprint" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_string_is_ascii" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_get_input" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_get_username" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_get_real_name" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + "silc_va_copy" "/home/priikone/silc1/doc/toolkit/silcutil.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcutillib.html b/docs/toolkit/manual/silcutillib.html new file mode 100644 index 0000000..5887d39 --- /dev/null +++ b/docs/toolkit/manual/silcutillib.html @@ -0,0 +1,275 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC Utility Library +
    +Directory: lib/silcutil/ +
    +Library: libsilc.a, libsilc.lib +

    +Introduction + +

    +SILC Utility Library provides a full featured runtime library for +applications. It provides the application's main loop, called SILC +Scheduler, threads, locks, file utilities, file streams, socket streams, +TCP and UDP network routines, a finite state machine, lists, a hash table, +UTF-8 routines and other string utilities, and many other utility routines. +The library works on multiple platforms. + +

    + +
  • Basic Types and Definitions +
  • Data Buffer Interface +
  • Data Buffer Format Interface +
  • Hash Table Interface +
  • Memory Allocation Interface +
  • Data Stack (memory pool) Interface +
  • Finite State Machine Interface +
  • Thread Interface +
  • Mutual Exclusion Lock Interface +
  • Condition Variable Interface +
  • Atomic Operations Interface +
  • Network (TCP and UDP) Interface +
  • Scheduler Interface +
  • Asynchronous Operation Interface +
  • Abstract Stream Interface +
  • Socket Stream Interface +
  • File Descriptor Stream Interface +
  • File Utility Functions +
  • String Utility Interface +
  • Snprintf Interface +
  • UTF-8 String Interface +
  • Stringprep Interface +
  • Utility Functions +
  • List Interface +
  • Dynamic List Interface +
  • MIME Interface +
  • Time Utility Functions +
  • Logging Interface +
  • Config File Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard-SilcVCard.html b/docs/toolkit/manual/silcvcard-SilcVCard.html new file mode 100644 index 0000000..74fc4c0 --- /dev/null +++ b/docs/toolkit/manual/silcvcard-SilcVCard.html @@ -0,0 +1,274 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Structure SilcVCard

    + + +NAME + +
    
+    typedef struct { ... } SilcVCardStruct, *SilcVCard;
+
+
    +DESCRIPTION + +
    
+    This structure is the VCard.  This holds the contents of the
+    card.  When a card is parsed it is parsed into this structure.
+    When creating a new card application fills this structure and
+    the library encodes the card from it.  Free the allocated
+    structure with silc_vcard_free function.
+
+
    +SOURCE + +
        typedef struct SilcVCardObject {
+      char *full_name;          /* full name, X.520 common name */
+      char *family_name;        /* last name, string */
+      char *first_name;         /* first name, string */
+      char *middle_names;       /* other names, string (comma sep.) */
+      char *prefix;             /* honorifix prefix (Mr., Mrs.), string */
+      char *suffix;             /* honorifix suffix (MD), string (comma sep.) */
+      char *nickname;           /* string (comma sep. if more than one) */
+      char *bday;               /* birth day, UTC date string */
+      char *title;              /* job title X.520, string */
+      char *role;               /* job role X.520, string */
+      char *org_name;           /* organization name, string */
+      char *org_unit;           /* organization unit, string */
+      char *categories;         /* application category, string */
+      char *catclass;           /* class (public, private, confidental), string */
+      char *url;                /* home page, URI string */
+      char *label;              /* formatted address label, string (same
+                                   format as for 'addr' but comma sep.) */
+    
+      struct addr {
+        char *type;             /* address type, string
+                                   (intl, dom, home, work, pref, postal, parcel) */
+        char *pbox;             /* post office box, string */
+        char *ext_addr;         /* extended address, string */
+        char *street_addr;      /* street address, string */
+        char *city;             /* city, string */
+        char *state;            /* state/province, string */
+        char *code;             /* postal code, string */
+        char *country;          /* country name, string */
+      } *addrs;
+      SilcUInt8 num_addrs;      /* number of addresses */
+    
+      struct tel {
+        char *type;             /* telephone number type, string
+                                   (msg, voice, home, work, pref, bbs, modem, car,
+                                   cell, video, pager, isdn, fax) */
+        char *telnum;           /* single telephone number, string */
+      } *tels;
+      SilcUInt8 num_tels;
+    
+      struct email {
+        char *type;             /* email type, string (internet, pref, x400) */
+        char *address;          /* single email address, string */
+      } *emails;
+      SilcUInt8 num_emails;
+    
+      char *note;               /* a note, string */
+      char *rev;                /* revision of card, UTC date string */
+    
+      SilcBool dynamic;                 /* TRUE when dynamically allocated */
+    } SilcVCardStruct, *SilcVCard;
    +



    +
    +     		+ + + + +
    +
    + +SILC VCard
    +SilcVCard
    +silc_vcard_encode
    +silc_vcard_decode
    +silc_vcard_alloc
    +silc_vcard_free
    +silc_vcard_fprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard-silc_vcard_alloc.html b/docs/toolkit/manual/silcvcard-silc_vcard_alloc.html new file mode 100644 index 0000000..40ded90 --- /dev/null +++ b/docs/toolkit/manual/silcvcard-silc_vcard_alloc.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_vcard_alloc

    + + +SYNOPSIS + +
    
+    SilcVCard silc_vcard_alloc(void);
+
+
    +DESCRIPTION + +
    
+    Allocate a SilcVCard context which must be freed with the
+    silc_vcard_free function.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC VCard
    +SilcVCard
    +silc_vcard_encode
    +silc_vcard_decode
    +silc_vcard_alloc
    +silc_vcard_free
    +silc_vcard_fprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard-silc_vcard_decode.html b/docs/toolkit/manual/silcvcard-silc_vcard_decode.html new file mode 100644 index 0000000..a07ea76 --- /dev/null +++ b/docs/toolkit/manual/silcvcard-silc_vcard_decode.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_vcard_decode

    + + +SYNOPSIS + +
    
+    SilcBool silc_vcard_decode(const unsigned char *data,
+                               SilcUInt32 data_len, SilcVCard vcard);
+
+
    +DESCRIPTION + +
    
+    Decodes VCard from the buffer `vcard' of length of `vcard_len' bytes
+    and returns the parsed card into `vcard' structure.  The caller must
+    pre-allocate the structure.  Returns TRUE if the `vcard' is valid
+    vcard and was successfully parsed or FALSE on error.  The structure
+    is freed with silc_vcard_free function when it is not needed anymore.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC VCard
    +SilcVCard
    +silc_vcard_encode
    +silc_vcard_decode
    +silc_vcard_alloc
    +silc_vcard_free
    +silc_vcard_fprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard-silc_vcard_encode.html b/docs/toolkit/manual/silcvcard-silc_vcard_encode.html new file mode 100644 index 0000000..5376a0a --- /dev/null +++ b/docs/toolkit/manual/silcvcard-silc_vcard_encode.html @@ -0,0 +1,221 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_vcard_encode

    + + +SYNOPSIS + +
    
+    char *silc_vcard_encode(SilcVCard vcard, SilcUInt32 *vcard_len);
+
+
    +DESCRIPTION + +
    
+    Encodes VCard from the SilcVCard structure indicated by `vcard'
+    which the caller must fill before calling this function.  This
+    function encodes the card and returns allocated buffer and
+    its length into `vcard_len'.  The caller must free the returned
+    buffer.  Returns NULL on error.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC VCard
    +SilcVCard
    +silc_vcard_encode
    +silc_vcard_decode
    +silc_vcard_alloc
    +silc_vcard_free
    +silc_vcard_fprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard-silc_vcard_fprintf.html b/docs/toolkit/manual/silcvcard-silc_vcard_fprintf.html new file mode 100644 index 0000000..aa7192c --- /dev/null +++ b/docs/toolkit/manual/silcvcard-silc_vcard_fprintf.html @@ -0,0 +1,218 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_vcard_fprintf

    + + +SYNOPSIS + +
    
+    void silc_vcard_fprintf(SilcVCard vcard, FILE *stream);
+
+
    +DESCRIPTION + +
    
+    Prints the contents of the `vcard' into file stream `stream' in
+    the correct VCard format.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC VCard
    +SilcVCard
    +silc_vcard_encode
    +silc_vcard_decode
    +silc_vcard_alloc
    +silc_vcard_free
    +silc_vcard_fprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard-silc_vcard_free.html b/docs/toolkit/manual/silcvcard-silc_vcard_free.html new file mode 100644 index 0000000..dc686ec --- /dev/null +++ b/docs/toolkit/manual/silcvcard-silc_vcard_free.html @@ -0,0 +1,217 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + +Function silc_vcard_free

    + + +SYNOPSIS + +
    
+    void silc_vcard_free(SilcVCard vcard);
+
+
    +DESCRIPTION + +
    
+    Free VCard structure and all data in it.
+
+
    +



    +
    +     		+ + + + +
    +
    + +SILC VCard
    +SilcVCard
    +silc_vcard_encode
    +silc_vcard_decode
    +silc_vcard_alloc
    +silc_vcard_free
    +silc_vcard_fprintf
    +     + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard.html b/docs/toolkit/manual/silcvcard.html new file mode 100644 index 0000000..9d670d0 --- /dev/null +++ b/docs/toolkit/manual/silcvcard.html @@ -0,0 +1,222 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +silcvcard.html + + + + +
    + +SILC VCard
    Header: silcvcard.h

    + + +DESCRIPTION + +
    
+ Implementation of the VCard 3.0 standard (RFC 2426) that can be used
+ with Requested Attributes (in WHOIS command) to deliver personal
+ information.  All fields are not supported since some of the
+ information are not needed in context of SILC.  If such VCard is
+ received this implementation ignores the unsupported fields.
+
+
  • SilcVCard +
  • silc_vcard_encode +
  • silc_vcard_decode +
  • silc_vcard_alloc +
  • silc_vcard_free +
  • silc_vcard_fprintf + +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/silcvcard.xref b/docs/toolkit/manual/silcvcard.xref new file mode 100644 index 0000000..e24afac --- /dev/null +++ b/docs/toolkit/manual/silcvcard.xref @@ -0,0 +1,13 @@ +/* XREF-File generated by ROBODoc v3.2.3 */ + +XREF: + "/tmp/silcdoc.html/silcvcard.h" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 0 + "SILC VCard" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 1 + "SilcVCard" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 5 + "silc_vcard_encode" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 4 + "silc_vcard_decode" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 4 + "silc_vcard_alloc" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 4 + "silc_vcard_free" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 4 + "silc_vcard_fprintf" "/home/priikone/silc1/doc/toolkit/silcvcard.html" 4 + +/* End of XREF-File */ diff --git a/docs/toolkit/manual/silcvcardlib.html b/docs/toolkit/manual/silcvcardlib.html new file mode 100644 index 0000000..86e60f8 --- /dev/null +++ b/docs/toolkit/manual/silcvcardlib.html @@ -0,0 +1,216 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + +SILC VCard Library +
    +Directory: lib/silcvcard/ +
    +Library: libvcard.a, libvcard.lib +

    +Introduction + +

    +SILC VCard Library provides interface for creating and processing VCards, +defined in the RFC 2426. The VCard 3.0 standard is implemented by the +library. + +

    + +
  • SILC VCard Interface +



    +
    • +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/space.gif b/docs/toolkit/manual/space.gif new file mode 100644 index 0000000000000000000000000000000000000000..e66849ac47bb7fe7aee32dd7591989bed35b7566 GIT binary patch literal 43 scmZ?wbhEHbWMp7uX!y@?;J^U}1_s5SEQ~;kK?g*DWE_~7To@Uw0o36KdjJ3c literal 0 HcmV?d00001 diff --git a/docs/toolkit/manual/toolkit_index.html b/docs/toolkit/manual/toolkit_index.html new file mode 100644 index 0000000..d1c5c93 --- /dev/null +++ b/docs/toolkit/manual/toolkit_index.html @@ -0,0 +1,2670 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + +



    +
    +     		+ + + + +
    +
    + + +SILC Toolkit Index + + + + +
    +

    SILC Toolkit Index

    +

    Modules

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ASN.1 InterfaceBER Interface
    Client Library InterfaceClient Library Interface
    SFTP Filesystems InterfaceSILC Application Utilities
    SILC Argument InterfaceSILC Async Operation Interface
    SILC Atomic Operations InterfaceSILC Attribute Interface
    SILC Authentication InterfaceSILC Buffer Format Interface
    SILC Buffer InterfaceSILC Channel Interface
    SILC Cipher InterfaceSILC Command Interface
    SILC Condition Variable InterfaceSILC Config Interface
    SILC Connection AuthenticationSILC Dynamic List Interface
    SILC File Descriptor Stream InterfaceSILC File Util Interface
    SILC Finite State MachineSILC HMAC Interface
    SILC HTTP PHP TranslatorSILC HTTP Server Interface
    SILC Hash InterfaceSILC Hash Table Interface
    SILC ID Cache InterfaceSILC ID Interface
    SILC Key RepositorySILC List Interface
    SILC Logging InterfaceSILC MIME Interface
    SILC MP InterfaceSILC Math Interface
    SILC Memory InterfaceSILC Message Interface
    SILC ModesSILC Mutex Interface
    SILC Net InterfaceSILC Notify Interface
    SILC PKCS InterfaceSILC PKCS1 Interface
    SILC Packet Engine InterfaceSILC Public Key Interface
    SILC Public Key PayloadSILC RNG Interface
    SILC SFTP InterfaceSILC SKE Interface
    SILC Schedule InterfaceSILC Socket Stream Interface
    SILC Status TypesSILC Stream Interface
    SILC String UtilitiesSILC Stringprep
    SILC Thread InterfaceSILC Time Interface
    SILC TypesSILC UTF-8 Interface
    SILC UtilitiesSILC VCard
    SKE Diffie Hellman GroupsSKE Payloads
    Server Library InterfaceSilcExampleAPI
    SilcStack InterfaceSnprintf
    silcdh.h
    +

    Structures

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SilcArgumentDecodedListSilcArgumentPayloadSilcAsn1
    SilcAsn1StructSilcAsyncOperationSilcAsyncOperationStruct
    SilcAtomic16SilcAtomic32SilcAtomic8
    SilcAtomicPointerSilcAttributeObjDeviceSilcAttributeObjGeo
    SilcAttributeObjPNSilcAttributeObjPkSilcAttributeObjService
    SilcAttributePayloadSilcAuthPayloadSilcBuffer
    SilcChannelEntrySilcChannelIDSilcChannelKeyPayload
    SilcChannelPayloadSilcChannelPrivateKeySilcChannelUser
    SilcCipherSilcClientSilcClientConnection
    SilcClientConnectionParamsSilcClientEntrySilcClientID
    SilcClientOperationsSilcClientParamsSilcClientStats
    SilcCommandPayloadSilcCondSilcConfigEntity
    SilcConfigFileSilcConfigTableSilcConnAuth
    SilcDHSilcDListSilcExampleStruct
    SilcFSMSilcFSMEventSilcFSMEventStruct
    SilcFSMStructSilcFSMThreadSilcFSMThreadStruct
    SilcHashSilcHashObjectSilcHashTable
    SilcHashTableListSilcHmacSilcHmacObject
    SilcHttpConnectionSilcHttpServerSilcID
    SilcIDCacheSilcIDCacheEntrySilcIDIP
    SilcIDPayloadSilcKeyAgreementPayloadSilcList
    SilcMessagePayloadSilcMimeSilcMimeAssembler
    SilcMutexSilcNetListenerSilcNotifyPayload
    SilcPacketSilcPacketCallbacksSilcPacketEngine
    SilcPacketStreamSilcPrivateKeySilcPrivateMessageKeys
    SilcPublicKeySilcPublicKeyIdentifierSilcRng
    SilcRwLockSilcSFTPSilcSFTPAttributes
    SilcSFTPFilesystemSilcSFTPFilesystemOpsSilcSFTPHandle
    SilcSFTPMonitorDataSilcSFTPNameSilcSILCPrivateKey
    SilcSILCPublicKeySilcSKEDiffieHellmanGroupSilcSKEKEPayload
    SilcSKEKeyMaterialSilcSKEParamsSilcSKERekeyMaterial
    SilcSKESecurityPropertiesSilcSKEStartPayloadSilcSKR
    SilcSKRFindSilcSKRKeySilcSchedule
    SilcServerSilcServerEntrySilcServerID
    SilcStackSilcStackFrameSilcStream
    SilcStreamOpsSilcTaskSilcThread
    SilcTimeSilcVCardsilc_cond_alloc
    silc_cond_broadcastsilc_cond_freesilc_cond_signal
    silc_cond_timedwaitsilc_cond_wait
    +

    Functions

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    SILC_ASN1_ANYSILC_ASN1_ANY_PRIMITIVE
    SILC_ASN1_BIT_STRINGSILC_ASN1_BMP_STRING
    SILC_ASN1_BOOLEANSILC_ASN1_CHOICE
    SILC_ASN1_ENDSILC_ASN1_ENUM
    SILC_ASN1_GENERAL_STRINGSILC_ASN1_GEN_TIME
    SILC_ASN1_IA5_STRINGSILC_ASN1_INT
    SILC_ASN1_NULLSILC_ASN1_NUMERIC_STRING
    SILC_ASN1_OCTET_STRINGSILC_ASN1_OID
    SILC_ASN1_OPTSSILC_ASN1_PRINTABLE_STRING
    SILC_ASN1_SEQUENCESILC_ASN1_SEQUENCE_OF
    SILC_ASN1_SETSILC_ASN1_SET_OF
    SILC_ASN1_SHORT_INTSILC_ASN1_TELETEX_STRING
    SILC_ASN1_UNIVERSAL_STRINGSILC_ASN1_UNRESTRICTED_STRING
    SILC_ASN1_UTC_TIMESILC_ASN1_UTF8_STRING
    SILC_ASN1_VISIBLE_STRINGSILC_FSM_EVENT_SIGNAL
    SilcAskPassphraseSilcAsyncOperationAbort
    SilcAsyncOperationPauseSilcBufferFormatFunc
    SilcBufferSFormatFuncSilcBufferSUnformatFunc
    SilcBufferUnformatFuncSilcClientCommandReply
    SilcClientConnectCallbackSilcClientFileAskName
    SilcClientFileMonitorSilcClientFileName
    SilcClientRunningSilcClientStopped
    SilcCommandCbSilcConfigCallback
    SilcConnAuthCompletionSilcConnAuthGetAuthData
    SilcFSMDestructorSilcFSMThreadDestructor
    SilcGetAuthMethSilcGetChannelCallback
    SilcGetClientCallbackSilcGetServerCallback
    SilcHashCompareSilcHashDestructor
    SilcHashForeachSilcHashFunction
    SilcHttpServerCallbackSilcIDCacheDestructor
    SilcKeyAgreementCallbackSilcLogCb
    SilcLogDebugCbSilcLogHexdumpCb
    SilcNetCallbackSilcNetResolveCallback
    SilcPacketEosCbSilcPacketErrorCb
    SilcPacketReceiveCbSilcPacketWrapCoder
    SilcSFTPAttrCallbackSilcSFTPDataCallback
    SilcSFTPErrorCallbackSilcSFTPExtendedCallback
    SilcSFTPHandleCallbackSilcSFTPMonitor
    SilcSFTPNameCallbackSilcSFTPStatusCallback
    SilcSFTPVersionCallbackSilcSKECompletionCb
    SilcSKEVerifyCbSilcSKEVerifyCbCompletion
    SilcSKRFindCallbackSilcServerRunning
    SilcServerStopSilcSocketStreamCallback
    SilcStreamNotifierSilcTaskCallback
    SilcTaskNotifyCbSilcThreadStart
    SilcVerifyPublicKeysilc_argument_get_arg_num
    silc_argument_get_arg_typesilc_argument_get_decoded
    silc_argument_get_first_argsilc_argument_get_next_arg
    silc_argument_list_freesilc_argument_list_parse
    silc_argument_list_parse_decodedsilc_argument_payload_encode
    silc_argument_payload_encode_onesilc_argument_payload_encode_payload
    silc_argument_payload_freesilc_argument_payload_parse
    silc_asn1_allocsilc_asn1_decode
    silc_asn1_encodesilc_asn1_free
    silc_asn1_initsilc_asn1_uninit
    silc_asprintfsilc_async_abort
    silc_async_allocsilc_async_free
    silc_async_get_contextsilc_async_halt
    silc_async_initsilc_async_resume
    silc_atomic_add_int16silc_atomic_add_int32
    silc_atomic_add_int8silc_atomic_cas16
    silc_atomic_cas32silc_atomic_cas8
    silc_atomic_cas_pointersilc_atomic_dec16
    silc_atomic_dec32silc_atomic_dec8
    silc_atomic_get_int16silc_atomic_get_int32
    silc_atomic_get_int8silc_atomic_get_pointer
    silc_atomic_inc16silc_atomic_inc32
    silc_atomic_inc8silc_atomic_init16
    silc_atomic_init32silc_atomic_init8
    silc_atomic_init_pointersilc_atomic_set_int16
    silc_atomic_set_int32silc_atomic_set_int8
    silc_atomic_set_pointersilc_atomic_sub_int16
    silc_atomic_sub_int32silc_atomic_sub_int8
    silc_atomic_uninit16silc_atomic_uninit32
    silc_atomic_uninit8silc_atomic_uninit_pointer
    silc_attribute_get_attributesilc_attribute_get_data
    silc_attribute_get_flagssilc_attribute_get_object
    silc_attribute_get_verify_datasilc_attribute_payload_alloc
    silc_attribute_payload_encodesilc_attribute_payload_encode_data
    silc_attribute_payload_freesilc_attribute_payload_list_free
    silc_attribute_payload_parsesilc_auth_get_data
    silc_auth_get_methodsilc_auth_get_public_data
    silc_auth_payload_encodesilc_auth_payload_free
    silc_auth_payload_parsesilc_auth_public_key_auth_generate
    silc_auth_public_key_auth_generate_wpubsilc_auth_public_key_auth_verify
    silc_auth_public_key_auth_verify_datasilc_auth_verify
    silc_auth_verify_datasilc_base64_encode
    silc_base64_encode_filesilc_base_decode
    silc_ber_decodesilc_ber_encode
    silc_ber_encoded_lensilc_buffer_alloc
    silc_buffer_alloc_sizesilc_buffer_clear
    silc_buffer_clonesilc_buffer_copy
    silc_buffer_datasilc_buffer_datalen
    silc_buffer_endsilc_buffer_enlarge
    silc_buffer_formatsilc_buffer_format_vp
    silc_buffer_freesilc_buffer_pull
    silc_buffer_pull_tailsilc_buffer_purge
    silc_buffer_pushsilc_buffer_push_tail
    silc_buffer_putsilc_buffer_put_head
    silc_buffer_put_tailsilc_buffer_realloc
    silc_buffer_realloc_sizesilc_buffer_reset
    silc_buffer_sallocsilc_buffer_salloc_size
    silc_buffer_sclonesilc_buffer_scopy
    silc_buffer_senlargesilc_buffer_set
    silc_buffer_sformatsilc_buffer_sformat_vp
    silc_buffer_sreallocsilc_buffer_srealloc_size
    silc_buffer_sstrformatsilc_buffer_start
    silc_buffer_stealsilc_buffer_strformat
    silc_buffer_sunformatsilc_buffer_sunformat_vp
    silc_buffer_unformatsilc_buffer_unformat_vp
    silc_callocsilc_change_private_key_passphrase
    silc_channel_get_idsilc_channel_get_id_parse
    silc_channel_get_modesilc_channel_get_name
    silc_channel_key_get_ciphersilc_channel_key_get_id
    silc_channel_key_get_keysilc_channel_key_payload_encode
    silc_channel_key_payload_freesilc_channel_key_payload_parse
    silc_channel_name_checksilc_channel_name_verify
    silc_channel_payload_encodesilc_channel_payload_free
    silc_channel_payload_list_freesilc_channel_payload_parse
    silc_channel_payload_parse_listsilc_check_line
    silc_cipher_allocsilc_cipher_decrypt
    silc_cipher_encryptsilc_cipher_free
    silc_cipher_get_block_lensilc_cipher_get_iv
    silc_cipher_get_iv_lensilc_cipher_get_key_len
    silc_cipher_get_modesilc_cipher_get_name
    silc_cipher_get_supportedsilc_cipher_is_supported
    silc_cipher_registersilc_cipher_register_default
    silc_cipher_set_ivsilc_cipher_set_key
    silc_cipher_unregistersilc_cipher_unregister_all
    silc_client_abort_key_agreementsilc_client_add_channel_private_key
    silc_client_add_private_message_keysilc_client_add_private_message_key_ske
    silc_client_allocsilc_client_attribute_add
    silc_client_attribute_delsilc_client_attributes_get
    silc_client_attributes_requestsilc_client_chmode
    silc_client_chumodesilc_client_chumode_char
    silc_client_close_connectionsilc_client_command_call
    silc_client_command_pendingsilc_client_command_send
    silc_client_connect_to_clientsilc_client_connect_to_server
    silc_client_current_channel_private_keysilc_client_del_channel_private_key
    silc_client_del_channel_private_keyssilc_client_del_private_message_key
    silc_client_file_closesilc_client_file_receive
    silc_client_file_sendsilc_client_free
    silc_client_free_private_message_keyssilc_client_get_channel
    silc_client_get_channel_by_idsilc_client_get_channel_by_id_resolve
    silc_client_get_channel_resolvesilc_client_get_client_by_id
    silc_client_get_client_by_id_resolvesilc_client_get_clients
    silc_client_get_clients_localsilc_client_get_clients_whois
    silc_client_get_serversilc_client_get_server_by_id
    silc_client_get_server_by_id_resolvesilc_client_init
    silc_client_key_exchangesilc_client_list_channel_private_keys
    silc_client_list_freesilc_client_list_free_channel
    silc_client_list_free_serversilc_client_list_private_message_keys
    silc_client_lock_channelsilc_client_lock_client
    silc_client_lock_serversilc_client_nickname_format
    silc_client_nickname_parsesilc_client_on_channel
    silc_client_perform_key_agreementsilc_client_perform_key_agreement_stream
    silc_client_private_message_key_is_setsilc_client_private_message_wait
    silc_client_private_message_wait_initsilc_client_private_message_wait_uninit
    silc_client_ref_channelsilc_client_ref_client
    silc_client_ref_serversilc_client_run
    silc_client_run_onesilc_client_send_channel_message
    silc_client_send_key_agreementsilc_client_send_private_message
    silc_client_set_away_messagesilc_client_stop
    silc_client_unlock_channelsilc_client_unlock_client
    silc_client_unlock_serversilc_client_unref_channel
    silc_client_unref_clientsilc_client_unref_server
    silc_command_freesilc_command_get
    silc_command_get_argssilc_command_get_ident
    silc_command_get_statussilc_command_payload_encode
    silc_command_payload_encode_payloadsilc_command_payload_encode_va
    silc_command_payload_encode_vapsilc_command_payload_parse
    silc_command_reply_payload_encode_vasilc_command_reply_payload_encode_vap
    silc_command_set_commandsilc_command_set_ident
    silc_compare_timevalsilc_config_close
    silc_config_get_filenamesilc_config_get_line
    silc_config_initsilc_config_main
    silc_config_opensilc_config_read_current_line
    silc_config_read_linesilc_config_register
    silc_config_register_tablesilc_config_strerror
    silc_connauth_allocsilc_connauth_free
    silc_connauth_get_skesilc_connauth_initiator
    silc_connauth_respondersilc_create_key_pair
    silc_dh_allocsilc_dh_compute_key
    silc_dh_compute_publicsilc_dh_free
    silc_dh_generate_privatesilc_dh_remote_public
    silc_dh_remote_public(1)silc_dlist_add
    silc_dlist_countsilc_dlist_del
    silc_dlist_endsilc_dlist_get
    silc_dlist_initsilc_dlist_insert
    silc_dlist_startsilc_dlist_uninit
    silc_example_functionsilc_fd_stream_create
    silc_fd_stream_create2silc_fd_stream_file
    silc_fd_stream_file2silc_fd_stream_get_error
    silc_fd_stream_get_infosilc_file_close
    silc_file_opensilc_file_open_mode
    silc_file_readsilc_file_readfile
    silc_file_set_nonblocksilc_file_size
    silc_file_writesilc_file_writefile
    silc_file_writefile_modesilc_fingerprint
    silc_formatsilc_free
    silc_fsm_allocsilc_fsm_continue
    silc_fsm_continue_syncsilc_fsm_event_alloc
    silc_fsm_event_freesilc_fsm_event_init
    silc_fsm_finishsilc_fsm_free
    silc_fsm_get_contextsilc_fsm_get_machine
    silc_fsm_get_schedulesilc_fsm_get_state_context
    silc_fsm_initsilc_fsm_is_started
    silc_fsm_nextsilc_fsm_next_later
    silc_fsm_set_contextsilc_fsm_set_state_context
    silc_fsm_startsilc_fsm_start_sync
    silc_fsm_thread_allocsilc_fsm_thread_init
    silc_get_command_namesilc_get_input
    silc_get_mode_listsilc_get_packet_name
    silc_get_real_namesilc_get_status_message
    silc_get_usernamesilc_gets
    silc_gettimeofdaysilc_hash_alloc
    silc_hash_alloc_by_oidsilc_hash_babbleprint
    silc_hash_block_lensilc_hash_client_id_compare
    silc_hash_client_id_hashsilc_hash_data
    silc_hash_data_comparesilc_hash_final
    silc_hash_fingerprintsilc_hash_free
    silc_hash_get_namesilc_hash_get_oid
    silc_hash_get_supportedsilc_hash_id
    silc_hash_id_comparesilc_hash_id_compare_full
    silc_hash_initsilc_hash_is_supported
    silc_hash_lensilc_hash_make
    silc_hash_ptrsilc_hash_public_key
    silc_hash_public_key_comparesilc_hash_register
    silc_hash_register_defaultsilc_hash_string
    silc_hash_string_comparesilc_hash_table_add
    silc_hash_table_add_extsilc_hash_table_alloc
    silc_hash_table_countsilc_hash_table_del
    silc_hash_table_del_by_contextsilc_hash_table_del_by_context_ext
    silc_hash_table_del_extsilc_hash_table_find
    silc_hash_table_find_by_contextsilc_hash_table_find_by_context_ext
    silc_hash_table_find_extsilc_hash_table_find_foreach
    silc_hash_table_find_foreach_extsilc_hash_table_foreach
    silc_hash_table_freesilc_hash_table_get
    silc_hash_table_listsilc_hash_table_list_reset
    silc_hash_table_rehashsilc_hash_table_rehash_ext
    silc_hash_table_replacesilc_hash_table_replace_ext
    silc_hash_table_sizesilc_hash_transform
    silc_hash_uintsilc_hash_unregister
    silc_hash_unregister_allsilc_hash_update
    silc_hash_utf8_comparesilc_hash_utf8_string
    silc_hmac_allocsilc_hmac_final
    silc_hmac_freesilc_hmac_get_hash
    silc_hmac_get_keysilc_hmac_get_name
    silc_hmac_get_supportedsilc_hmac_init
    silc_hmac_init_with_keysilc_hmac_is_supported
    silc_hmac_lensilc_hmac_make
    silc_hmac_make_truncatedsilc_hmac_make_with_key
    silc_hmac_registersilc_hmac_register_default
    silc_hmac_set_keysilc_hmac_unregister
    silc_hmac_unregister_allsilc_hmac_update
    silc_http_phpsilc_http_php_file
    silc_http_server_add_headersilc_http_server_alloc
    silc_http_server_freesilc_http_server_get_header
    silc_http_server_sendsilc_http_server_send_error
    silc_id_dupsilc_id_get_len
    silc_id_id2strsilc_id_payload_encode
    silc_id_payload_encode_datasilc_id_payload_free
    silc_id_payload_get_datasilc_id_payload_get_id
    silc_id_payload_get_lensilc_id_payload_get_type
    silc_id_payload_parsesilc_id_payload_parse_id
    silc_id_rendersilc_id_str2id
    silc_id_str2id2silc_idcache_add
    silc_idcache_allocsilc_idcache_del
    silc_idcache_del_by_contextsilc_idcache_del_by_id
    silc_idcache_find_by_contextsilc_idcache_find_by_id
    silc_idcache_find_by_id_onesilc_idcache_find_by_name
    silc_idcache_find_by_name_onesilc_idcache_free
    silc_idcache_get_allsilc_idcache_move
    silc_idcache_updatesilc_idcache_update_by_context
    silc_identifier_checksilc_identifier_verify
    silc_key_agreement_get_hostnamesilc_key_agreement_get_port
    silc_key_agreement_get_protocolsilc_key_agreement_payload_encode
    silc_key_agreement_payload_freesilc_key_agreement_payload_parse
    silc_list_addsilc_list_count
    silc_list_delsilc_list_end
    silc_list_getsilc_list_init
    silc_list_init_prevsilc_list_insert
    silc_list_startsilc_load_key_pair
    silc_log_flush_allsilc_log_flushdelay
    silc_log_get_filesilc_log_quick
    silc_log_reset_allsilc_log_reset_callbacks
    silc_log_reset_debug_callbackssilc_log_set_callback
    silc_log_set_debug_callbackssilc_log_set_debug_string
    silc_log_set_filesilc_log_timestamp
    silc_mallocsilc_math_gen_prime
    silc_math_prime_testsilc_memdup
    silc_message_get_datasilc_message_get_flags
    silc_message_get_macsilc_message_payload_decrypt
    silc_message_payload_encodesilc_message_payload_encrypt
    silc_message_payload_freesilc_message_payload_parse
    silc_message_signed_get_public_keysilc_message_signed_verify
    silc_mime_add_datasilc_mime_add_field
    silc_mime_add_multipartsilc_mime_alloc
    silc_mime_assemblesilc_mime_assembler_alloc
    silc_mime_assembler_freesilc_mime_decode
    silc_mime_encodesilc_mime_encode_partial
    silc_mime_freesilc_mime_get_data
    silc_mime_get_fieldsilc_mime_get_multiparts
    silc_mime_is_multipartsilc_mime_is_partial
    silc_mime_partial_freesilc_mime_set_multipart
    silc_mime_steal_datasilc_mp_abs
    silc_mp_addsilc_mp_add_ui
    silc_mp_andsilc_mp_bin2mp
    silc_mp_cmpsilc_mp_cmp_si
    silc_mp_cmp_uisilc_mp_div
    silc_mp_div_2expsilc_mp_div_2exp_qr
    silc_mp_div_qrsilc_mp_div_ui
    silc_mp_gcdsilc_mp_gcdext
    silc_mp_get_strsilc_mp_get_ui
    silc_mp_initsilc_mp_mod
    silc_mp_mod_2expsilc_mp_mod_ui
    silc_mp_modinvsilc_mp_mp2bin
    silc_mp_mp2bin_noallocsilc_mp_mul
    silc_mp_mul_2expsilc_mp_mul_ui
    silc_mp_negsilc_mp_or
    silc_mp_powsilc_mp_pow_mod
    silc_mp_pow_mod_uisilc_mp_pow_ui
    silc_mp_setsilc_mp_set_si
    silc_mp_set_strsilc_mp_set_ui
    silc_mp_sizesilc_mp_sizeinbase
    silc_mp_sqrtsilc_mp_sub
    silc_mp_sub_uisilc_mp_uninit
    silc_mp_xorsilc_mutex_alloc
    silc_mutex_assert_lockedsilc_mutex_free
    silc_mutex_locksilc_mutex_unlock
    silc_net_accept_connectionsilc_net_addr2bin
    silc_net_check_host_by_socksilc_net_check_local_by_sock
    silc_net_close_connectionsilc_net_close_listener
    silc_net_get_error_stringsilc_net_get_local_port
    silc_net_get_remote_portsilc_net_get_socket_opt
    silc_net_gethostbyaddrsilc_net_gethostbyaddr_async
    silc_net_gethostbynamesilc_net_gethostbyname_async
    silc_net_is_ipsilc_net_is_ip4
    silc_net_is_ip6silc_net_listener_get_hostname
    silc_net_listener_get_ipsilc_net_listener_get_port
    silc_net_localhostsilc_net_localip
    silc_net_set_socket_nonblocksilc_net_set_socket_opt
    silc_net_tcp_connectsilc_net_tcp_create_listener
    silc_net_udp_connectsilc_net_udp_receive
    silc_net_udp_sendsilc_notify_get_arg_num
    silc_notify_get_argssilc_notify_get_type
    silc_notify_payload_encodesilc_notify_payload_encode_args
    silc_notify_payload_freesilc_notify_payload_parse
    silc_packet_engine_free_streams_listsilc_packet_engine_get_streams
    silc_packet_engine_startsilc_packet_engine_stop
    silc_packet_error_stringsilc_packet_free
    silc_packet_get_contextsilc_packet_get_engine
    silc_packet_get_idssilc_packet_get_keys
    silc_packet_get_sendersilc_packet_send
    silc_packet_send_extsilc_packet_send_va
    silc_packet_send_va_extsilc_packet_set_context
    silc_packet_set_idssilc_packet_set_keys
    silc_packet_set_sidsilc_packet_stream_add_remote
    silc_packet_stream_createsilc_packet_stream_destroy
    silc_packet_stream_get_streamsilc_packet_stream_inject
    silc_packet_stream_is_udpsilc_packet_stream_is_valid
    silc_packet_stream_linksilc_packet_stream_ref
    silc_packet_stream_set_iv_includedsilc_packet_stream_set_router
    silc_packet_stream_set_streamsilc_packet_stream_unlink
    silc_packet_stream_unrefsilc_packet_stream_wrap
    silc_packet_waitsilc_packet_wait_init
    silc_packet_wait_uninitsilc_parse_command_line
    silc_parse_userfqdnsilc_parse_version_string
    silc_pkcs1_decodesilc_pkcs1_encode
    silc_pkcs_algorithm_registersilc_pkcs_algorithm_unregister
    silc_pkcs_decryptsilc_pkcs_encrypt
    silc_pkcs_find_algorithmsilc_pkcs_find_pkcs
    silc_pkcs_get_algorithmsilc_pkcs_get_context
    silc_pkcs_get_namesilc_pkcs_get_pkcs
    silc_pkcs_get_supportedsilc_pkcs_get_type
    silc_pkcs_load_private_keysilc_pkcs_load_public_key
    silc_pkcs_private_key_allocsilc_pkcs_private_key_free
    silc_pkcs_private_key_get_lensilc_pkcs_public_key_alloc
    silc_pkcs_public_key_comparesilc_pkcs_public_key_copy
    silc_pkcs_public_key_exportsilc_pkcs_public_key_free
    silc_pkcs_public_key_get_lensilc_pkcs_register
    silc_pkcs_register_defaultsilc_pkcs_save_private_key
    silc_pkcs_save_public_keysilc_pkcs_sign
    silc_pkcs_silc_decode_identifiersilc_pkcs_silc_encode_identifier
    silc_pkcs_silc_generate_keysilc_pkcs_silc_public_key_version
    silc_pkcs_unregistersilc_pkcs_unregister_all
    silc_pkcs_verifysilc_public_key_payload_decode
    silc_public_key_payload_encodesilc_realloc
    silc_rng_add_noisesilc_rng_alloc
    silc_rng_freesilc_rng_get_byte
    silc_rng_get_byte_fastsilc_rng_get_rn16
    silc_rng_get_rn32silc_rng_get_rn_data
    silc_rng_get_rn_stringsilc_rng_global_add_noise
    silc_rng_global_get_bytesilc_rng_global_get_byte_fast
    silc_rng_global_get_rn16silc_rng_global_get_rn32
    silc_rng_global_get_rn_datasilc_rng_global_get_rn_string
    silc_rng_global_initsilc_rng_global_uninit
    silc_rng_initsilc_rwlock_alloc
    silc_rwlock_freesilc_rwlock_rdlock
    silc_rwlock_unlocksilc_rwlock_wrlock
    silc_scallocsilc_schedule
    silc_schedule_get_contextsilc_schedule_get_fd_events
    silc_schedule_initsilc_schedule_one
    silc_schedule_set_listen_fdsilc_schedule_set_notify
    silc_schedule_stopsilc_schedule_task_add_fd
    silc_schedule_task_add_signalsilc_schedule_task_add_timeout
    silc_schedule_task_delsilc_schedule_task_del_by_all
    silc_schedule_task_del_by_callbacksilc_schedule_task_del_by_context
    silc_schedule_task_del_by_fdsilc_schedule_uninit
    silc_schedule_unset_listen_fdsilc_schedule_wakeup
    silc_server_allocsilc_server_free
    silc_server_params_add_adminsilc_server_params_add_cipher
    silc_server_params_add_clientsilc_server_params_add_connparam
    silc_server_params_add_denysilc_server_params_add_hash
    silc_server_params_add_hmacsilc_server_params_add_pkcs
    silc_server_params_add_routersilc_server_params_add_server
    silc_server_params_allocsilc_server_params_free
    silc_server_params_serverinfo_allocsilc_server_params_serverinfo_alloc(1)
    silc_server_params_set_serverinfosilc_server_run
    silc_server_run(1)silc_sftp_client_shutdown
    silc_sftp_client_startsilc_sftp_close
    silc_sftp_extendedsilc_sftp_fs_memory_add_dir
    silc_sftp_fs_memory_add_filesilc_sftp_fs_memory_alloc
    silc_sftp_fs_memory_del_dirsilc_sftp_fs_memory_del_file
    silc_sftp_fs_memory_freesilc_sftp_fsetstat
    silc_sftp_fstatsilc_sftp_lstat
    silc_sftp_mkdirsilc_sftp_open
    silc_sftp_opendirsilc_sftp_read
    silc_sftp_readdirsilc_sftp_readlink
    silc_sftp_realpathsilc_sftp_remove
    silc_sftp_renamesilc_sftp_rmdir
    silc_sftp_server_set_monitorsilc_sftp_server_shutdown
    silc_sftp_server_startsilc_sftp_setstat
    silc_sftp_statsilc_sftp_symlink
    silc_sftp_writesilc_show_public_key
    silc_show_public_key_filesilc_ske_alloc
    silc_ske_freesilc_ske_free_key_material
    silc_ske_free_rekey_materialsilc_ske_get_context
    silc_ske_get_key_materialsilc_ske_get_security_properties
    silc_ske_get_supported_groupssilc_ske_group_free
    silc_ske_group_get_by_namesilc_ske_group_get_by_number
    silc_ske_group_get_namesilc_ske_group_get_number
    silc_ske_initiatorsilc_ske_map_status
    silc_ske_parse_versionsilc_ske_payload_ke_decode
    silc_ske_payload_ke_encodesilc_ske_payload_ke_free
    silc_ske_payload_start_decodesilc_ske_payload_start_encode
    silc_ske_payload_start_freesilc_ske_process_key_material_data
    silc_ske_rekey_initiatorsilc_ske_rekey_responder
    silc_ske_respondersilc_ske_set_callbacks
    silc_ske_set_keyssilc_skr_add_public_key
    silc_skr_add_public_key_simplesilc_skr_alloc
    silc_skr_del_public_keysilc_skr_find
    silc_skr_find_add_pkcs_typesilc_skr_find_alloc
    silc_skr_find_freesilc_skr_find_set_context
    silc_skr_find_set_countrysilc_skr_find_set_email
    silc_skr_find_set_hostsilc_skr_find_set_org
    silc_skr_find_set_public_keysilc_skr_find_set_realname
    silc_skr_find_set_usagesilc_skr_find_set_username
    silc_skr_freesilc_skr_init
    silc_skr_ref_public_keysilc_skr_uninit
    silc_skr_unref_public_keysilc_smalloc
    silc_smalloc_uasilc_smemdup
    silc_snprintfsilc_socket_stream_get_error
    silc_socket_stream_get_infosilc_socket_stream_is_udp
    silc_socket_stream_set_infosilc_socket_stream_set_qos
    silc_socket_tcp_stream_createsilc_socket_udp_stream_create
    silc_sreallocsilc_srealloc_ua
    silc_sstrdupsilc_stack_alloc
    silc_stack_freesilc_stack_pop
    silc_stack_pushsilc_status_get_args
    silc_stream_closesilc_stream_destroy
    silc_stream_get_schedulesilc_stream_read
    silc_stream_set_notifiersilc_stream_write
    silc_string_comparesilc_string_is_ascii
    silc_string_matchsilc_string_regex_match
    silc_string_regexifysilc_string_split
    silc_stringprepsilc_strncat
    silc_thread_createsilc_thread_exit
    silc_thread_selfsilc_thread_wait
    silc_thread_yieldsilc_time
    silc_time_generalizedsilc_time_generalized_string
    silc_time_msecsilc_time_string
    silc_time_universalsilc_time_universal_string
    silc_time_usecsilc_time_value
    silc_timezonesilc_to_lower
    silc_to_uppersilc_usleep
    silc_utf8_c2wsilc_utf8_decode
    silc_utf8_decoded_lensilc_utf8_encode
    silc_utf8_encoded_lensilc_utf8_strcasecmp
    silc_utf8_strncasecmpsilc_utf8_valid
    silc_utf8_w2csilc_va_copy
    silc_vasprintfsilc_vcard_alloc
    silc_vcard_decodesilc_vcard_encode
    silc_vcard_fprintfsilc_vcard_free
    silc_version_to_numsilc_vsnprintf
    +

    Global Variables

    + + + + + + +
    silc_log_debugsilc_log_debug_hexdump
    +

    Constants

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ChannelModesChannelUserModesFALSE
    SILC_32_TO_PTRSILC_64_TO_PTRSILC_ALL_TASKS
    SILC_ASSERTSILC_CONFIG_CALLBACKSILC_FSM_CALL
    SILC_FSM_CALL_CONTINUESILC_FSM_CALL_CONTINUE_SYNCSILC_FSM_CONTINUE
    SILC_FSM_EVENT_TIMEDWAITSILC_FSM_EVENT_WAITSILC_FSM_FINISH
    SILC_FSM_STATESILC_FSM_THREAD_WAITSILC_FSM_WAIT
    SILC_FSM_YIELDSILC_GET16_LSBSILC_GET16_MSB
    SILC_GET32_LSBSILC_GET32_MSBSILC_GET64_MSB
    SILC_ID_CHANNEL_COMPARESILC_ID_CLIENT_COMPARESILC_ID_COMPARE
    SILC_ID_COMPARE_HASHSILC_ID_COMPARE_TYPESILC_ID_GET_ID
    SILC_ID_SERVER_COMPARESILC_LIST_ENDSILC_LOG_DEBUG
    SILC_LOG_ERRORSILC_LOG_FATALSILC_LOG_HEXDUMP
    SILC_LOG_INFOSILC_LOG_WARNINGSILC_PTR_TO_32
    SILC_PTR_TO_64SILC_PUT16_LSBSILC_PUT16_MSB
    SILC_PUT32_LSBSILC_PUT32_MSBSILC_PUT64_MSB
    SILC_STRFMT_ENDSILC_STR_*_CHARSILC_STR_*_INT
    SILC_STR_*_INT64SILC_STR_*_NSTRINGSILC_STR_*_SHORT
    SILC_STR_*_STRINGSILC_STR_ADVANCESILC_STR_BUFFER
    SILC_STR_DATASILC_STR_ENDSILC_STR_FUNC
    SILC_STR_OFFSETSILC_SWAB_16SILC_SWAB_32
    SILC_TASK_CALLBACKSILC_VERIFYSilcArgumentDecodeType
    SilcAsn1OptionsSilcAsn1TagSilcAttribute
    SilcAttributeContactSilcAttributeDeviceSilcAttributeFlags
    SilcAttributeMoodSilcAttributePNFormatSilcAuthMethod
    SilcBerClassSilcBerEncodingSilcBool
    SilcBufferParamTypeSilcCipherModeSilcClientConnectionStatus
    SilcClientFileErrorSilcClientMessageTypeSilcClientMonitorStatus
    SilcCommandSilcCommandFlagsSilcConfigErrno
    SilcConfigTypeSilcConnectionTypeSilcExampleType
    SilcIdTypeSilcInt16SilcInt32
    SilcInt64SilcInt8SilcKeyAgreementStatus
    SilcLogTypeSilcMPIntSilcMessageFlags
    SilcNetStatusSilcNotifyTypeSilcPKCSFileEncoding
    SilcPKCSTypeSilcPacketErrorSilcPacketFlags
    SilcPacketTypeSilcPkcs1BlockTypeSilcSFTPFSMemoryPerm
    SilcSFTPFileOperationSilcSFTPMonitorsSilcSFTPStatus
    SilcSFTPVersionSilcSKEPKTypeSilcSKESecurityPropertyFlag
    SilcSKEStatusSilcSKRKeyUsageSilcSKRStatus
    SilcSocketSilcSocketStreamStatusSilcStatus
    SilcStreamStatusSilcStringEncodingSilcStringprepFlags
    SilcStringprepStatusSilcTaskEventSilcUInt16
    SilcUInt32SilcUInt64SilcUInt8
    SilcUserModeTRUEsilc_buffer_headlen
    silc_buffer_lensilc_buffer_taillensilc_buffer_truelen
    + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + diff --git a/docs/toolkit/manual/zlib.html b/docs/toolkit/manual/zlib.html new file mode 100644 index 0000000..1be3630 --- /dev/null +++ b/docs/toolkit/manual/zlib.html @@ -0,0 +1,1165 @@ + + + + + + + + + + + + + + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + +
    + + + + + + + + + + + + + + +
    + + + +
    +
    + + + +SILC Toolkit Reference Manual
    + + +SILC Crypto Library
    +    Introduction to SILC RNG
    +    SILC RNG Interface
    +    SILC Cipher API
    +    SILC PKCS API
    +    SILC Public Key API
    +    SILC PKCS #1 API
    +    SILC Hash Interface
    +    SILC HMAC Interface
    +SILC Core Library
    +    SILC Authentication Interface
    +    SILC Message Interface
    +    SILC Channel Interface
    +    SILC Command Interface
    +    SILC Notify Interface
    +    SILC Status Types
    +    SILC Modes
    +    SILC ID Interface
    +    SILC Argument Interface
    +    SILC Attributes Interface
    +    Packet Engine Interface
    +    SILC Public Key Payload Interface
    +SILC Key Exchange Library
    +    SILC SKE Interface
    +    SILC Connection Authentication Interface
    +SILC VCard Library
    +    SILC VCard Interface
    +SILC Math Library
    +    SILC MP Interface
    +    SILC Math Interface
    +SILC Client Library
    +    Using SILC Client Library Tutorial
    +    Arguments for command_reply Client Operation
    +    SilcStatus Error Arguments in command_reply Client Operation
    +    Arguments for notify Client Operation
    +    Unicode and UTF-8 Strings in Client Library
    +    Client Library Interface Reference
    +    Client Entry Interface Reference
    +SILC ASN.1 Library
    +    SILC ASN.1 Interface
    +    SILC BER interface
    +SILC HTTP Library
    +    SILC HTTP Server Interface
    +    SILC HTTP PHP Translator
    +SILC Utility Library
    +    Basic Types and Definitions
    +    Data Buffer Interface
    +    Data Buffer Format Interface
    +    Hash Table Interface
    +    Memory Allocation Interface
    +    Data Stack (memory pool) Interface
    +    Finite State Machine Interface
    +    Thread Interface
    +    Mutual Exclusion Lock Interface
    +    Condition Variable Interface
    +    Atomic Operations Interface
    +    Network (TCP and UDP) Interface
    +    Scheduler Interface
    +    Asynchronous Operation Interface
    +    Abstract Stream Interface
    +    Socket Stream Interface
    +    File Descriptor Stream Interface
    +    File Utility Functions
    +    String Utility Interface
    +    Snprintf Interface
    +    UTF-8 String Interface
    +    Stringprep Interface
    +    Utility Functions
    +    List Interface
    +    Dynamic List Interface
    +    MIME Interface
    +    Time Utility Functions
    +    Logging Interface
    +    Config File Interface
    +SILC Key Repository Library
    +    SILC SKR Interface
    +SILC Application Utility Library
    +    SILC Application Utilities
    +    SILC ID Cache Interface
    +SILC SFTP Library
    +    SILC SFTP Interface
    +    SFTP Filesystems Interface
    + +
    +Resource Links +
    +SILC Project Website
    +SILC Protocol Documentation
    +SILC White Paper
    +SILC FAQs
    + +     +



    +
    +     		+ + + + +
    +
    + + + + zlib general purpose compression library version 1.1.4 + + + + + +

    zlib 1.1.4 Manual

    +
    +

    Contents

    +
      +
    1. Prologue +
    2. Introduction +
    3. Utility functions +
    4. Basic functions +
    5. Advanced functions +
    6. Constants +
    7. struct z_stream_s +
    8. Checksum functions +
    9. Misc +
    +
    +

    Prologue

    + 'zlib' general purpose compression library version 1.1.4, March 11th, 2002 +

    + Copyright (C) 1995-2002 Jean-loup Gailly and Mark Adler +

    + This software is provided 'as-is', without any express or implied + warranty. In no event will the authors be held liable for any damages + arising from the use of this software. +

    + Permission is granted to anyone to use this software for any purpose, + including commercial applications, and to alter it and redistribute it + freely, subject to the following restrictions: +

      +
    1. The origin of this software must not be misrepresented ; you must not + claim that you wrote the original software. If you use this software + in a product, an acknowledgment in the product documentation would be + appreciated but is not required. +
    2. Altered source versions must be plainly marked as such, and must not be + misrepresented as being the original software. +
    3. This notice may not be removed or altered from any source distribution. +
    + +
    +
    Jean-loup Gailly +
    jloup@gzip.org +
    Mark Adler +
    madler@alumni.caltech.edu +
    + + The data format used by the zlib library is described by RFCs (Request for + Comments) 1950 to 1952 in the files + + ftp://ds.internic.net/rfc/rfc1950.txt + (zlib format), + + rfc1951.txt + (deflate format) and + + rfc1952.txt + (gzip format). +

    + This manual is converted from zlib.h by + piaip +

    + Visit + http://ftp.cdrom.com/pub/infozip/zlib/ + for the official zlib web page. +

    + +

    +

    Introduction

    + The 'zlib' compression library provides in-memory compression and + decompression functions, including integrity checks of the uncompressed + data. This version of the library supports only one compression method + (deflation) but other algorithms will be added later and will have the same + stream interface. +

    + + Compression can be done in a single step if the buffers are large + enough (for example if an input file is mmap'ed), or can be done by + repeated calls of the compression function. In the latter case, the + application must provide more input and/or consume the output + (providing more output space) before each call. +

    + + The library also supports reading and writing files in gzip (.gz) format + with an interface similar to that of stdio. +

    + + The library does not install any signal handler. The decoder checks + the consistency of the compressed data, so the library should never + crash even in case of corrupted input. +

    + +

    +

    Utility functions

    + The following utility functions are implemented on top of the +     basic stream-oriented functions. + To simplify the interface, some + default options are assumed (compression level and memory usage, + standard memory allocation functions). The source code of these + utility functions can easily be modified if you need special options. +

    Function list

    +
      +
    • int compress (Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen); +
    • int compress2 (Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen, int level); +
    • int uncompress (Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen); +
    • typedef voidp gzFile; +
    • gzFile gzopen (const char *path, const char *mode); +
    • gzFile gzdopen (int fd, const char *mode); +
    • int gzsetparams (gzFile file, int level, int strategy); +
    • int gzread (gzFile file, voidp buf, unsigned len); +
    • int gzwrite (gzFile file, const voidp buf, unsigned len); +
    • int VA gzprintf (gzFile file, const char *format, ...); +
    • int gzputs (gzFile file, const char *s); +
    • char * gzgets (gzFile file, char *buf, int len); +
    • int gzputc (gzFile file, int c); +
    • int gzgetc (gzFile file); +
    • int gzflush (gzFile file, int flush); +
    • z_off_t gzseek (gzFile file, z_off_t offset, int whence); +
    • z_off_t gztell (gzFile file); +
    • int gzrewind (gzFile file); +
    • int gzeof (gzFile file); +
    • int gzclose (gzFile file); +
    • const char * gzerror (gzFile file, int *errnum); +
    +

    Function description

    +
    +
    int compress (Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen); +
    + Compresses the source buffer into the destination buffer. sourceLen is + the byte length of the source buffer. Upon entry, destLen is the total + size of the destination buffer, which must be at least 0.1% larger than + sourceLen plus 12 bytes. Upon exit, destLen is the actual size of the + compressed buffer.

    + This function can be used to compress a whole file at once if the + input file is mmap'ed.

    + compress returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_BUF_ERROR if there was not enough room in the output + buffer.

    + +

    int compress2 (Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen, int level); +
    + Compresses the source buffer into the destination buffer. The level + parameter has the same meaning as in deflateInit. sourceLen is the byte + length of the source buffer. Upon entry, destLen is the total size of the + destination buffer, which must be at least 0.1% larger than sourceLen plus + 12 bytes. Upon exit, destLen is the actual size of the compressed buffer. +

    + + compress2 returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_BUF_ERROR if there was not enough room in the output buffer, + Z_STREAM_ERROR if the level parameter is invalid. +

    + +

    int uncompress (Bytef *dest, uLongf *destLen, const Bytef *source, uLong sourceLen); +
    + Decompresses the source buffer into the destination buffer. sourceLen is + the byte length of the source buffer. Upon entry, destLen is the total + size of the destination buffer, which must be large enough to hold the + entire uncompressed data. (The size of the uncompressed data must have + been saved previously by the compressor and transmitted to the decompressor + by some mechanism outside the scope of this compression library.) + Upon exit, destLen is the actual size of the compressed buffer.

    + This function can be used to decompress a whole file at once if the + input file is mmap'ed. +

    + + uncompress returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_BUF_ERROR if there was not enough room in the output + buffer, or Z_DATA_ERROR if the input data was corrupted. +

    + +

    typedef voidp gzFile; +

    + +

    gzFile gzopen (const char *path, const char *mode); +
    + Opens a gzip (.gz) file for reading or writing. The mode parameter + is as in fopen ("rb" or "wb") but can also include a compression level + ("wb9") or a strategy: 'f' for filtered data as in "wb6f", 'h' for + Huffman only compression as in "wb1h". (See the description + of deflateInit2 for more information about the strategy parameter.) +

    + + gzopen can be used to read a file which is not in gzip format ; in this + case gzread will directly read from the file without decompression. +

    + + gzopen returns NULL if the file could not be opened or if there was + insufficient memory to allocate the (de)compression state ; errno + can be checked to distinguish the two cases (if errno is zero, the + zlib error is Z_MEM_ERROR). +

    + +

    gzFile gzdopen (int fd, const char *mode); +
    + gzdopen() associates a gzFile with the file descriptor fd. File + descriptors are obtained from calls like open, dup, creat, pipe or + fileno (in the file has been previously opened with fopen). + The mode parameter is as in gzopen. +

    + The next call of gzclose on the returned gzFile will also close the + file descriptor fd, just like fclose(fdopen(fd), mode) closes the file + descriptor fd. If you want to keep fd open, use gzdopen(dup(fd), mode). +

    + gzdopen returns NULL if there was insufficient memory to allocate + the (de)compression state. +

    + +

    int gzsetparams (gzFile file, int level, int strategy); +
    + Dynamically update the compression level or strategy. See the description + of deflateInit2 for the meaning of these parameters. +

    + gzsetparams returns Z_OK if success, or Z_STREAM_ERROR if the file was not + opened for writing. +

    + +

    int gzread (gzFile file, voidp buf, unsigned len); +
    + Reads the given number of uncompressed bytes from the compressed file. + If the input file was not in gzip format, gzread copies the given number + of bytes into the buffer. +

    + gzread returns the number of uncompressed bytes actually read (0 for + end of file, -1 for error). +

    + +

    int gzwrite (gzFile file, const voidp buf, unsigned len); +
    + Writes the given number of uncompressed bytes into the compressed file. + gzwrite returns the number of uncompressed bytes actually written + (0 in case of error). +

    + +

    int VA gzprintf (gzFile file, const char *format, ...); +
    + Converts, formats, and writes the args to the compressed file under + control of the format string, as in fprintf. gzprintf returns the number of + uncompressed bytes actually written (0 in case of error). +

    + +

    int gzputs (gzFile file, const char *s); +
    + Writes the given null-terminated string to the compressed file, excluding + the terminating null character. +

    + gzputs returns the number of characters written, or -1 in case of error. +

    + +

    char * gzgets (gzFile file, char *buf, int len); +
    + Reads bytes from the compressed file until len-1 characters are read, or + a newline character is read and transferred to buf, or an end-of-file + condition is encountered. The string is then terminated with a null + character. +

    + gzgets returns buf, or Z_NULL in case of error. +

    + +

    int gzputc (gzFile file, int c); +
    + Writes c, converted to an unsigned char, into the compressed file. + gzputc returns the value that was written, or -1 in case of error. +

    + +

    int gzgetc (gzFile file); +
    + Reads one byte from the compressed file. gzgetc returns this byte + or -1 in case of end of file or error. +

    + +

    int gzflush (gzFile file, int flush); +
    + Flushes all pending output into the compressed file. The parameter + flush is as in the deflate() function. The return value is the zlib + error number (see function gzerror below). gzflush returns Z_OK if + the flush parameter is Z_FINISH and all output could be flushed. +

    + gzflush should be called only when strictly necessary because it can + degrade compression. +

    + +

    z_off_t gzseek (gzFile file, z_off_t offset, int whence); +
    + Sets the starting position for the next gzread or gzwrite on the + given compressed file. The offset represents a number of bytes in the + uncompressed data stream. The whence parameter is defined as in lseek(2); + the value SEEK_END is not supported. +

    + If the file is opened for reading, this function is emulated but can be + extremely slow. If the file is opened for writing, only forward seeks are + supported ; gzseek then compresses a sequence of zeroes up to the new + starting position. +

    + gzseek returns the resulting offset location as measured in bytes from + the beginning of the uncompressed stream, or -1 in case of error, in + particular if the file is opened for writing and the new starting position + would be before the current position. +

    + +

    int gzrewind (gzFile file); +
    + Rewinds the given file. This function is supported only for reading. +

    + gzrewind(file) is equivalent to (int)gzseek(file, 0L, SEEK_SET) +

    + +

    z_off_t gztell (gzFile file); +
    + Returns the starting position for the next gzread or gzwrite on the + given compressed file. This position represents a number of bytes in the + uncompressed data stream. +

    + + gztell(file) is equivalent to gzseek(file, 0L, SEEK_CUR) +

    + +

    int gzeof (gzFile file); +
    + Returns 1 when EOF has previously been detected reading the given + input stream, otherwise zero. +

    + +

    int gzclose (gzFile file); +
    + Flushes all pending output if necessary, closes the compressed file + and deallocates all the (de)compression state. The return value is the zlib + error number (see function gzerror below). +

    + +

    const char * gzerror (gzFile file, int *errnum); +
    + Returns the error message for the last error which occurred on the + given compressed file. errnum is set to zlib error number. If an + error occurred in the file system and not in the compression library, + errnum is set to Z_ERRNO and the application may consult errno + to get the exact error code. +

    +

    +
    +

    Basic functions

    +

    Function list

    +     + +

    Function description

    +
    +
    const char * zlibVersion (void); +
    The application can compare zlibVersion and ZLIB_VERSION for consistency. + If the first character differs, the library code actually used is + not compatible with the zlib.h header file used by the application. + This check is automatically made by deflateInit and inflateInit. +

    + +

    int deflateInit (z_streamp strm, int level); +
    + Initializes the internal stream state for compression. The fields + zalloc, zfree and opaque must be initialized before by the caller. + If zalloc and zfree are set to Z_NULL, deflateInit updates them to + use default allocation functions. +

    + + The compression level must be Z_DEFAULT_COMPRESSION, or between 0 and 9: + 1 gives best speed, 9 gives best compression, 0 gives no compression at + all (the input data is simply copied a block at a time). +

    + + Z_DEFAULT_COMPRESSION requests a default compromise between speed and + compression (currently equivalent to level 6). +

    + + deflateInit returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_STREAM_ERROR if level is not a valid compression level, + Z_VERSION_ERROR if the zlib library version (zlib_version) is incompatible + with the version assumed by the caller (ZLIB_VERSION). + msg is set to null if there is no error message. deflateInit does not + perform any compression: this will be done by deflate(). +

    + +

    int deflate (z_streamp strm, int flush); +
    + deflate compresses as much data as possible, and stops when the input + buffer becomes empty or the output buffer becomes full. It may introduce some + output latency (reading input without producing any output) except when + forced to flush.

    + + The detailed semantics are as follows. deflate performs one or both of the + following actions: + +

      +
    • Compress more input starting at next_in and update next_in and avail_in + accordingly. If not all input can be processed (because there is not + enough room in the output buffer), next_in and avail_in are updated and + processing will resume at this point for the next call of deflate(). + +
    • + Provide more output starting at next_out and update next_out and avail_out + accordingly. This action is forced if the parameter flush is non zero. + Forcing flush frequently degrades the compression ratio, so this parameter + should be set only when necessary (in interactive applications). + Some output may be provided even if flush is not set. +

    + + Before the call of deflate(), the application should ensure that at least + one of the actions is possible, by providing more input and/or consuming + more output, and updating avail_in or avail_out accordingly ; avail_out + should never be zero before the call. The application can consume the + compressed output when it wants, for example when the output buffer is full + (avail_out == 0), or after each call of deflate(). If deflate returns Z_OK + and with zero avail_out, it must be called again after making room in the + output buffer because there might be more output pending. +

    + + If the parameter flush is set to Z_SYNC_FLUSH, all pending output is + flushed to the output buffer and the output is aligned on a byte boundary, so + that the decompressor can get all input data available so far. (In particular + avail_in is zero after the call if enough output space has been provided + before the call.) Flushing may degrade compression for some compression + algorithms and so it should be used only when necessary. +

    + + If flush is set to Z_FULL_FLUSH, all output is flushed as with + Z_SYNC_FLUSH, and the compression state is reset so that decompression can + restart from this point if previous compressed data has been damaged or if + random access is desired. Using Z_FULL_FLUSH too often can seriously degrade + the compression. +

    + + If deflate returns with avail_out == 0, this function must be called again + with the same value of the flush parameter and more output space (updated + avail_out), until the flush is complete (deflate returns with non-zero + avail_out). +

    + + If the parameter flush is set to Z_FINISH, pending input is processed, + pending output is flushed and deflate returns with Z_STREAM_END if there + was enough output space ; if deflate returns with Z_OK, this function must be + called again with Z_FINISH and more output space (updated avail_out) but no + more input data, until it returns with Z_STREAM_END or an error. After + deflate has returned Z_STREAM_END, the only possible operations on the + stream are deflateReset or deflateEnd. +

    + + Z_FINISH can be used immediately after deflateInit if all the compression + is to be done in a single step. In this case, avail_out must be at least + 0.1% larger than avail_in plus 12 bytes. If deflate does not return + Z_STREAM_END, then it must be called again as described above. +

    + + deflate() sets strm-> adler to the adler32 checksum of all input read + so far (that is, total_in bytes). +

    + + deflate() may update data_type if it can make a good guess about + the input data type (Z_ASCII or Z_BINARY). In doubt, the data is considered + binary. This field is only for information purposes and does not affect + the compression algorithm in any manner. +

    + + deflate() returns Z_OK if some progress has been made (more input + processed or more output produced), Z_STREAM_END if all input has been + consumed and all output has been produced (only when flush is set to + Z_FINISH), Z_STREAM_ERROR if the stream state was inconsistent (for example + if next_in or next_out was NULL), Z_BUF_ERROR if no progress is possible + (for example avail_in or avail_out was zero). +

    + +

    int deflateEnd (z_streamp strm); +
    + All dynamically allocated data structures for this stream are freed. + This function discards any unprocessed input and does not flush any + pending output. +

    + + deflateEnd returns Z_OK if success, Z_STREAM_ERROR if the + stream state was inconsistent, Z_DATA_ERROR if the stream was freed + prematurely (some input or output was discarded). In the error case, + msg may be set but then points to a static string (which must not be + deallocated). +

    + +

    int inflateInit (z_streamp strm); +
    + Initializes the internal stream state for decompression. The fields + next_in, avail_in, zalloc, zfree and opaque must be initialized before by + the caller. If next_in is not Z_NULL and avail_in is large enough (the exact + value depends on the compression method), inflateInit determines the + compression method from the zlib header and allocates all data structures + accordingly ; otherwise the allocation will be deferred to the first call of + inflate. If zalloc and zfree are set to Z_NULL, inflateInit updates them to + use default allocation functions. +

    + + inflateInit returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_VERSION_ERROR if the zlib library version is incompatible with the + version assumed by the caller. msg is set to null if there is no error + message. inflateInit does not perform any decompression apart from reading + the zlib header if present: this will be done by inflate(). (So next_in and + avail_in may be modified, but next_out and avail_out are unchanged.) +

    + +

    int inflate (z_streamp strm, int flush); +
    + inflate decompresses as much data as possible, and stops when the input + buffer becomes empty or the output buffer becomes full. It may some + introduce some output latency (reading input without producing any output) + except when forced to flush. +

    + + The detailed semantics are as follows. inflate performs one or both of the + following actions: + +

      +
    • Decompress more input starting at next_in and update next_in and avail_in + accordingly. If not all input can be processed (because there is not + enough room in the output buffer), next_in is updated and processing + will resume at this point for the next call of inflate(). + +
    • Provide more output starting at next_out and update next_out and + avail_out accordingly. inflate() provides as much output as possible, + until there is no more input data or no more space in the output buffer + (see below about the flush parameter). +

    + + Before the call of inflate(), the application should ensure that at least + one of the actions is possible, by providing more input and/or consuming + more output, and updating the next_* and avail_* values accordingly. + The application can consume the uncompressed output when it wants, for + example when the output buffer is full (avail_out == 0), or after each + call of inflate(). If inflate returns Z_OK and with zero avail_out, it + must be called again after making room in the output buffer because there + might be more output pending. +

    + + If the parameter flush is set to Z_SYNC_FLUSH, inflate flushes as much + output as possible to the output buffer. The flushing behavior of inflate is + not specified for values of the flush parameter other than Z_SYNC_FLUSH + and Z_FINISH, but the current implementation actually flushes as much output + as possible anyway. +

    + + inflate() should normally be called until it returns Z_STREAM_END or an + error. However if all decompression is to be performed in a single step + (a single call of inflate), the parameter flush should be set to + Z_FINISH. In this case all pending input is processed and all pending + output is flushed ; avail_out must be large enough to hold all the + uncompressed data. (The size of the uncompressed data may have been saved + by the compressor for this purpose.) The next operation on this stream must + be inflateEnd to deallocate the decompression state. The use of Z_FINISH + is never required, but can be used to inform inflate that a faster routine + may be used for the single inflate() call. +

    + + If a preset dictionary is needed at this point (see inflateSetDictionary + below), inflate sets strm-adler to the adler32 checksum of the + dictionary chosen by the compressor and returns Z_NEED_DICT ; otherwise + it sets strm-> adler to the adler32 checksum of all output produced + so far (that is, total_out bytes) and returns Z_OK, Z_STREAM_END or + an error code as described below. At the end of the stream, inflate() + checks that its computed adler32 checksum is equal to that saved by the + compressor and returns Z_STREAM_END only if the checksum is correct. +

    + + inflate() returns Z_OK if some progress has been made (more input processed + or more output produced), Z_STREAM_END if the end of the compressed data has + been reached and all uncompressed output has been produced, Z_NEED_DICT if a + preset dictionary is needed at this point, Z_DATA_ERROR if the input data was + corrupted (input stream not conforming to the zlib format or incorrect + adler32 checksum), Z_STREAM_ERROR if the stream structure was inconsistent + (for example if next_in or next_out was NULL), Z_MEM_ERROR if there was not + enough memory, Z_BUF_ERROR if no progress is possible or if there was not + enough room in the output buffer when Z_FINISH is used. In the Z_DATA_ERROR + case, the application may then call inflateSync to look for a good + compression block. +

    + +

    int inflateEnd (z_streamp strm); +
    + All dynamically allocated data structures for this stream are freed. + This function discards any unprocessed input and does not flush any + pending output. +

    + + inflateEnd returns Z_OK if success, Z_STREAM_ERROR if the stream state + was inconsistent. In the error case, msg may be set but then points to a + static string (which must not be deallocated). +

    +
    +

    Advanced functions

    + The following functions are needed only in some special applications. +

    Function list

    +     +

    Function description

    +
    +
    int deflateInit2 (z_streamp strm, int level, int method, int windowBits, int memLevel, int strategy); + +
    This is another version of deflateInit with more compression options. The + fields next_in, zalloc, zfree and opaque must be initialized before by + the caller.

    + + The method parameter is the compression method. It must be Z_DEFLATED in + this version of the library.

    + + The windowBits parameter is the base two logarithm of the window size + (the size of the history buffer). It should be in the range 8..15 for this + version of the library. Larger values of this parameter result in better + compression at the expense of memory usage. The default value is 15 if + deflateInit is used instead.

    + + The memLevel parameter specifies how much memory should be allocated + for the internal compression state. memLevel=1 uses minimum memory but + is slow and reduces compression ratio ; memLevel=9 uses maximum memory + for optimal speed. The default value is 8. See zconf.h for total memory + usage as a function of windowBits and memLevel.

    + + The strategy parameter is used to tune the compression algorithm. Use the + value Z_DEFAULT_STRATEGY for normal data, Z_FILTERED for data produced by a + filter (or predictor), or Z_HUFFMAN_ONLY to force Huffman encoding only (no + string match). Filtered data consists mostly of small values with a + somewhat random distribution. In this case, the compression algorithm is + tuned to compress them better. The effect of Z_FILTERED is to force more + Huffman coding and less string matching ; it is somewhat intermediate + between Z_DEFAULT and Z_HUFFMAN_ONLY. The strategy parameter only affects + the compression ratio but not the correctness of the compressed output even + if it is not set appropriately.

    + + deflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_STREAM_ERROR if a parameter is invalid (such as an invalid + method). msg is set to null if there is no error message. deflateInit2 does + not perform any compression: this will be done by deflate().

    + +

    int deflateSetDictionary (z_streamp strm, const Bytef *dictionary, uInt dictLength); +
    + Initializes the compression dictionary from the given byte sequence + without producing any compressed output. This function must be called + immediately after deflateInit, deflateInit2 or deflateReset, before any + call of deflate. The compressor and decompressor must use exactly the same + dictionary (see inflateSetDictionary).

    + + The dictionary should consist of strings (byte sequences) that are likely + to be encountered later in the data to be compressed, with the most commonly + used strings preferably put towards the end of the dictionary. Using a + dictionary is most useful when the data to be compressed is short and can be + predicted with good accuracy ; the data can then be compressed better than + with the default empty dictionary.

    + + Depending on the size of the compression data structures selected by + deflateInit or deflateInit2, a part of the dictionary may in effect be + discarded, for example if the dictionary is larger than the window size in + deflate or deflate2. Thus the strings most likely to be useful should be + put at the end of the dictionary, not at the front.

    + + Upon return of this function, strm-> adler is set to the Adler32 value + of the dictionary ; the decompressor may later use this value to determine + which dictionary has been used by the compressor. (The Adler32 value + applies to the whole dictionary even if only a subset of the dictionary is + actually used by the compressor.)

    + + deflateSetDictionary returns Z_OK if success, or Z_STREAM_ERROR if a + parameter is invalid (such as NULL dictionary) or the stream state is + inconsistent (for example if deflate has already been called for this stream + or if the compression method is bsort). deflateSetDictionary does not + perform any compression: this will be done by deflate().

    + +

    int deflateCopy (z_streamp dest, z_streamp source); +
    + Sets the destination stream as a complete copy of the source stream.

    + + This function can be useful when several compression strategies will be + tried, for example when there are several ways of pre-processing the input + data with a filter. The streams that will be discarded should then be freed + by calling deflateEnd. Note that deflateCopy duplicates the internal + compression state which can be quite large, so this strategy is slow and + can consume lots of memory.

    + + deflateCopy returns Z_OK if success, Z_MEM_ERROR if there was not + enough memory, Z_STREAM_ERROR if the source stream state was inconsistent + (such as zalloc being NULL). msg is left unchanged in both source and + destination.

    + +

    int deflateReset (z_streamp strm); +
    This function is equivalent to deflateEnd followed by deflateInit, + but does not free and reallocate all the internal compression state. + The stream will keep the same compression level and any other attributes + that may have been set by deflateInit2.

    + + deflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent (such as zalloc or state being NULL).

    + +

    int deflateParams (z_streamp strm, int level, int strategy); +
    + Dynamically update the compression level and compression strategy. The + interpretation of level and strategy is as in deflateInit2. This can be + used to switch between compression and straight copy of the input data, or + to switch to a different kind of input data requiring a different + strategy. If the compression level is changed, the input available so far + is compressed with the old level (and may be flushed); the new level will + take effect only at the next call of deflate().

    + + Before the call of deflateParams, the stream state must be set as for + a call of deflate(), since the currently available input may have to + be compressed and flushed. In particular, strm-> avail_out must be + non-zero.

    + + deflateParams returns Z_OK if success, Z_STREAM_ERROR if the source + stream state was inconsistent or if a parameter was invalid, Z_BUF_ERROR + if strm->avail_out was zero.

    + +

    int inflateInit2 (z_streamp strm, int windowBits); + +
    This is another version of inflateInit with an extra parameter. The + fields next_in, avail_in, zalloc, zfree and opaque must be initialized + before by the caller.

    + + The windowBits parameter is the base two logarithm of the maximum window + size (the size of the history buffer). It should be in the range 8..15 for + this version of the library. The default value is 15 if inflateInit is used + instead. If a compressed stream with a larger window size is given as + input, inflate() will return with the error code Z_DATA_ERROR instead of + trying to allocate a larger window.

    + + inflateInit2 returns Z_OK if success, Z_MEM_ERROR if there was not enough + memory, Z_STREAM_ERROR if a parameter is invalid (such as a negative + memLevel). msg is set to null if there is no error message. inflateInit2 + does not perform any decompression apart from reading the zlib header if + present: this will be done by inflate(). (So next_in and avail_in may be + modified, but next_out and avail_out are unchanged.)

    + +

    int inflateSetDictionary (z_streamp strm, const Bytef *dictionary, uInt dictLength); +
    + Initializes the decompression dictionary from the given uncompressed byte + sequence. This function must be called immediately after a call of inflate + if this call returned Z_NEED_DICT. The dictionary chosen by the compressor + can be determined from the Adler32 value returned by this call of + inflate. The compressor and decompressor must use exactly the same + dictionary (see deflateSetDictionary).

    + + inflateSetDictionary returns Z_OK if success, Z_STREAM_ERROR if a + parameter is invalid (such as NULL dictionary) or the stream state is + inconsistent, Z_DATA_ERROR if the given dictionary doesn't match the + expected one (incorrect Adler32 value). inflateSetDictionary does not + perform any decompression: this will be done by subsequent calls of + inflate().

    + +

    int inflateSync (z_streamp strm); + +
    Skips invalid compressed data until a full flush point (see above the + description of deflate with Z_FULL_FLUSH) can be found, or until all + available input is skipped. No output is provided.

    + + inflateSync returns Z_OK if a full flush point has been found, Z_BUF_ERROR + if no more input was provided, Z_DATA_ERROR if no flush point has been found, + or Z_STREAM_ERROR if the stream structure was inconsistent. In the success + case, the application may save the current current value of total_in which + indicates where valid compressed data was found. In the error case, the + application may repeatedly call inflateSync, providing more input each time, + until success or end of the input data.

    + +

    int inflateReset (z_streamp strm); +
    + This function is equivalent to inflateEnd followed by inflateInit, + but does not free and reallocate all the internal decompression state. + The stream will keep attributes that may have been set by inflateInit2. +

    + + inflateReset returns Z_OK if success, or Z_STREAM_ERROR if the source + stream state was inconsistent (such as zalloc or state being NULL). +

    +

    + +
    +

    Checksum functions

    + These functions are not related to compression but are exported + anyway because they might be useful in applications using the + compression library. +

    Function list

    +     +

    Function description

    +
    +
    uLong adler32 (uLong adler, const Bytef *buf, uInt len); +
    + Update a running Adler-32 checksum with the bytes buf[0..len-1] and + return the updated checksum. If buf is NULL, this function returns + the required initial value for the checksum. +

    + An Adler-32 checksum is almost as reliable as a CRC32 but can be computed + much faster. Usage example: + 

    +
+     uLong adler = adler32(0L, Z_NULL, 0);
+
+     while (read_buffer(buffer, length) != EOF) {
+       adler = adler32(adler, buffer, length);
+     }
+     if (adler != original_adler) error();
+
    + +
    uLong crc32 (uLong crc, const Bytef *buf, uInt len); +
    + Update a running crc with the bytes buf[0..len-1] and return the updated + crc. If buf is NULL, this function returns the required initial value + for the crc. Pre- and post-conditioning (one's complement) is performed + within this function so it shouldn't be done by the application. + Usage example: + 
    +
+     uLong crc = crc32(0L, Z_NULL, 0);
+
+     while (read_buffer(buffer, length) != EOF) {
+       crc = crc32(crc, buffer, length);
+     }
+     if (crc != original_crc) error();
+
    +
    +
    +

    struct z_stream_s

    + +     +
    +typedef struct z_stream_s {
+    Bytef    *next_in;  /* next input byte */
+    uInt     avail_in;  /* number of bytes available at next_in */
+    uLong    total_in;  /* total nb of input bytes read so far */
+
+    Bytef    *next_out; /* next output byte should be put there */
+    uInt     avail_out; /* remaining free space at next_out */
+    uLong    total_out; /* total nb of bytes output so far */
+
+    char     *msg;      /* last error message, NULL if no error */
+    struct internal_state FAR *state; /* not visible by applications */
+
+    alloc_func zalloc;  /* used to allocate the internal state */
+    free_func  zfree;   /* used to free the internal state */
+    voidpf     opaque;  /* private data object passed to zalloc and zfree */
+
+    int     data_type;  /* best guess about the data type: ascii or binary */
+    uLong   adler;      /* adler32 value of the uncompressed data */
+    uLong   reserved;   /* reserved for future use */
+} z_stream ;
+
+typedef z_stream FAR * z_streamp;  ΓΏ 
+
    +     + The application must update next_in and avail_in when avail_in has + dropped to zero. It must update next_out and avail_out when avail_out + has dropped to zero. The application must initialize zalloc, zfree and + opaque before calling the init function. All other fields are set by the + compression library and must not be updated by the application.

    + + The opaque value provided by the application will be passed as the first + parameter for calls of zalloc and zfree. This can be useful for custom + memory management. The compression library attaches no meaning to the + opaque value.

    + + zalloc must return Z_NULL if there is not enough memory for the object. + If zlib is used in a multi-threaded application, zalloc and zfree must be + thread safe.

    + + On 16-bit systems, the functions zalloc and zfree must be able to allocate + exactly 65536 bytes, but will not be required to allocate more than this + if the symbol MAXSEG_64K is defined (see zconf.h). WARNING: On MSDOS, + pointers returned by zalloc for objects of exactly 65536 bytes *must* + have their offset normalized to zero. The default allocation function + provided by this library ensures this (see zutil.c). To reduce memory + requirements and avoid any allocation of 64K objects, at the expense of + compression ratio, compile the library with -DMAX_WBITS=14 (see zconf.h). +

    + + The fields total_in and total_out can be used for statistics or + progress reports. After compression, total_in holds the total size of + the uncompressed data and may be saved for use in the decompressor + (particularly if the decompressor wants to decompress everything in + a single step).

    + +

    +

    Constants

    + +
    +#define Z_NO_FLUSH      0
+#define Z_PARTIAL_FLUSH 1 
+	/* will be removed, use Z_SYNC_FLUSH instead */
+#define Z_SYNC_FLUSH    2
+#define Z_FULL_FLUSH    3
+#define Z_FINISH        4
+/* Allowed flush values ; see deflate() below for details */
+
+#define Z_OK            0
+#define Z_STREAM_END    1
+#define Z_NEED_DICT     2
+#define Z_ERRNO        (-1)
+#define Z_STREAM_ERROR (-2)
+#define Z_DATA_ERROR   (-3)
+#define Z_MEM_ERROR    (-4)
+#define Z_BUF_ERROR    (-5)
+#define Z_VERSION_ERROR (-6)
+/* Return codes for the compression/decompression functions. Negative
+ * values are errors, positive values are used for special but normal events.
+ */
+
+#define Z_NO_COMPRESSION         0
+#define Z_BEST_SPEED             1
+#define Z_BEST_COMPRESSION       9
+#define Z_DEFAULT_COMPRESSION  (-1)
+/* compression levels */
+
+#define Z_FILTERED            1
+#define Z_HUFFMAN_ONLY        2
+#define Z_DEFAULT_STRATEGY    0
+/* compression strategy ; see deflateInit2() below for details */
+
+#define Z_BINARY   0
+#define Z_ASCII    1
+#define Z_UNKNOWN  2
+/* Possible values of the data_type field */
+
+#define Z_DEFLATED   8
+/* The deflate compression method (the only one supported in this version) */
+
+#define Z_NULL  0  /* for initializing zalloc, zfree, opaque */
+
+#define zlib_version zlibVersion()
+/* for compatibility with versions less than 1.0.2 */
+
    +     + +
    +

    Misc

    +     deflateInit and inflateInit are macros to allow checking the zlib version + and the compiler's view of z_stream. +

    + Other functions: +

    +
    const char * zError (int err); +
    int inflateSyncPoint (z_streamp z); +
    const uLongf * get_crc_table (void); +
    +
    + + Last update: Wed Oct 13 20:42:34 1999
    + piapi@csie.ntu.edu.tw +     + + + +



    +
    +     		+ + + + +
    +
    + + + +



    +
    +
    + + + +
    + + + + + + +
    Copyright © 2001 - 2007 SILC Project
    + SILC Project Website    		 + SILC Toolkit Reference Manual
    + Index
    + + + -- 2.24.0